Developer tools
API
Building With Stripe
Sign in
Sign up
Support
Sign in
Developer tools
Libraries

API libraries

Stripe has official libraries for different programming languages and mobile platforms. There are also many more third-party libraries and plugins created by the Stripe community.

Client-side & UI libraries

Use Stripe on the web with Elements, a set of prebuilt UI components for collecting and validating card details. Elements uses Stripe.js, our foundational JavaScript library for building payment flows.

You need to include Stripe.js on your checkout page by either adding the script tag to the head of your HTML file, or importing it from the stripe-js module:

<script src="https://js.stripe.com/v3/"></script>

npm install @stripe/stripe-js

Next, create an instance of the Stripe object by providing your publishable API key as the first parameter:

var stripe = Stripe('pk_test_TYooMQauvdEDq54NiTphI7jx');

import {loadStripe} from '@stripe/stripe-js';

const stripe = await loadStripe('pk_test_TYooMQauvdEDq54NiTphI7jx');

Finally, create an instance of the Elements UI library:

var elements = stripe.elements();
const elements = stripe.elements();

Now you can use Elements to create payment forms with prebuilt input fields to collect payment method details. See accept a payment for detailed instructions.

Install React Stripe.js and the Stripe.js loader from the npm public registry.

npm install --save @stripe/react-stripe-js @stripe/stripe-js

We also provide a UMD build for sites that do not use npm or modules.

Include the Stripe.js script, which exports a global Stripe function, and the UMD build of React Stripe.js, which exports a global ReactStripe object. Always load the Stripe.js script directly from js.stripe.com to remain PCI compliant. Do not include the script in a bundle or host a copy of it yourself.

<!-- Stripe.js -->
<script src="https://js.stripe.com/v3/"></script>

<!-- React Stripe.js development build -->
<script src="https://unpkg.com/@stripe/react-stripe-js@latest/dist/react-stripe.umd.js"></script>

<!-- When you are ready to deploy your site to production, remove the
     above development script, and include the following production build. -->
<script src="https://unpkg.com/@stripe/react-stripe-js@latest/dist/react-stripe.umd.min.js"></script>

Add Stripe.js and Elements to your page

To use Element components, wrap the root of your React app in an Elements provider. Call loadStripe with your publishable key and pass the returned Promise to the Elements provider.

import React from 'react';
import ReactDOM from 'react-dom';
import {Elements} from '@stripe/react-stripe-js';
import {loadStripe} from '@stripe/stripe-js';

import CheckoutForm from './CheckoutForm';

// Make sure to call `loadStripe` outside of a component’s render to avoid
// recreating the `Stripe` object on every render.
const stripePromise = loadStripe("pk_test_TYooMQauvdEDq54NiTphI7jx");

function App() {
  return (
    <Elements stripe={stripePromise}>
      <CheckoutForm />
    </Elements>
  );
};

ReactDOM.render(<App />, document.getElementById('root'));

Now you can use Elements to create payment forms with prebuilt input fields to collect payment method details.

The iOS SDK is open source, fully documented, and compatible with apps supporting iOS 10 or above.

  1. If you haven't already, install the latest version of CocoaPods.
  2. If you don't have an existing Podfile, run the following command to create one: 
    pod init
  3. Add this line to your Podfile: 
    pod 'Stripe'
  4. Run the following command: 
    pod install
  5. Don't forget to use the .xcworkspace file to open your project in Xcode, instead of the .xcodeproj file, from here on out.
  6. In the future, to update to the latest version of the SDK, just run: 
    pod update Stripe
  1. If you haven't already, install the latest version of Carthage.
  2. Add this line to your Cartfile: 
    github "stripe/stripe-ios"
  3. Follow the Carthage installation instructions.
  4. In the future, to update to the latest version of the SDK, run the following command: 
    carthage update stripe-ios --platform ios
  1. Head to our GitHub releases page and download and unzip Stripe.framework.zip.
  2. Drag Stripe.framework to the "Embedded Binaries" section of your Xcode project's "General" settings. Make sure to select "Copy items if needed".
  3. Head to the "Build Phases" section of your Xcode project settings, and create a new "Run Script Build Phase". Paste the following snippet into the text field: 
    bash "${BUILT_PRODUCTS_DIR}/${FRAMEWORKS_FOLDER_PATH}/Stripe.framework/integrate-dynamic-framework.sh"
  4. In the future, to update to the latest version of our SDK, just repeat steps 1 and 2.

When your app starts, configure the SDK with your Stripe publishable key so that it can make requests to the Stripe API.

import UIKit
import Stripe

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        Stripe.setDefaultPublishableKey("pk_test_TYooMQauvdEDq54NiTphI7jx")
        // do any other necessary launch configuration
        return true
    }
}
#import "AppDelegate.h"
#import <Stripe/Stripe.h>

@implementation AppDelegate
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [Stripe setDefaultPublishableKey:@"pk_test_TYooMQauvdEDq54NiTphI7jx"];
    // do any other necessary launch configuration
    return YES;
}
@end

The Android SDK is open source and fully documented.

To install the SDK, add stripe-android to the dependencies block of your app/build.gradle file:

apply plugin: 'com.android.application'

android { ... }

dependencies {
  // ...

  // Stripe Android SDK
  implementation 'com.stripe:stripe-android:15.1.0'
}

Configure the SDK with your Stripe publishable key so that it can make requests to the Stripe API, such as in your Application subclass:

import com.stripe.android.PaymentConfiguration

class MyApp : Application() {
    override fun onCreate() {
        super.onCreate()
        PaymentConfiguration.init(
            applicationContext,
            "pk_test_TYooMQauvdEDq54NiTphI7jx"
        )
    }
}

import com.stripe.android.PaymentConfiguration;

public class MyApp extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        PaymentConfiguration.init(
            getApplicationContext(),
            "pk_test_TYooMQauvdEDq54NiTphI7jx"
        );
    }
}

Server-side libraries

# Available as a gem
gem install stripe
# If you use bundler, you can add this line to your Gemfile
gem 'stripe'

For more details, check out the API reference or see the source code on GitHub.

Versioning

When backwards-incompatible changes are made to the API, a new, dated version is released. Read our API upgrades guide to see our API changelog and to learn more about backwards compatibility.

To override the API version, assign the version to the Stripe.api_version property:

require 'stripe'
Stripe.api_key = 'sk_test_4eC39HqLyjWDarjtT1zdp7dc'
Stripe.api_version = '2020-08-27'

Or set it per-request:

require 'stripe'
intent = Stripe::PaymentIntent.retrieve(
  'pi_1DhDdc2eZvKYlo2ClEJ6fGTE',
  {
    stripe_version: '2020-08-27',
  }
)
intent.capture

When overriding it per-request, methods on the returned object reuse the same Stripe version.

You can visit your Dashboard to upgrade your account API version.

Upgrading your server-side library

Minor updates to our libraries are backwards compatible and are generally safe to upgrade to. Major updates often include breaking changes, which may require changes to your code when upgrading. A major version upgrade is sometimes required to use new features.

Before upgrading your API version in the Dashboard, review both the API changelog and the library changelog.

Update the the version in your Gemfile. You can find the latest library version at the top of the changelog file.

# If you use bundler, you can add this line to your Gemfile
gem 'stripe', 'X.XX.X'
bundle install
# Install through pip
pip install --upgrade stripe
# Or find the Stripe package on http://pypi.python.org/pypi/stripe/
# Find the version you want to pin:
# https://github.com/stripe/stripe-python/blob/master/CHANGELOG.md
# Specify that version in your requirements.txt file
stripe>=2.48.0,<3.0

For more details, check out the API reference or see the source code on GitHub.

Versioning

When backwards-incompatible changes are made to the API, a new, dated version is released. Read our API upgrades guide to see our API changelog and to learn more about backwards compatibility.

To override the API version, assign the version to the stripe.api_version property:

import stripe
stripe.api_key = "sk_test_4eC39HqLyjWDarjtT1zdp7dc"
stripe.api_version = "2020-08-27"

Or set it per-request:

import stripe
intent = stripe.PaymentIntent.retrieve(
  "pi_1DhDdc2eZvKYlo2ClEJ6fGTE",
  stripe_version="2020-08-27"
)
intent.capture()

When overriding it per-request, methods on the returned object reuse the same Stripe version.

You can visit your Dashboard to upgrade your account API version.

Upgrading your server-side library

Minor updates to our libraries are backwards compatible and are generally safe to upgrade to. Major updates often include breaking changes, which may require changes to your code when upgrading. A major version upgrade is sometimes required to use new features.

Before upgrading your API version in the Dashboard, review both the API changelog and the library changelog.

Update the version in your requirements.txt file and run:

pip install -r requirements.txt
# Install the PHP library via Composer
composer require stripe/stripe-php
# Or download the source directly: https://github.com/stripe/stripe-php/releases

For more details, check out the API reference or see the source code on GitHub.

Versioning

When backwards-incompatible changes are made to the API, a new, dated version is released. Read our API upgrades guide to see our API changelog and to learn more about backwards compatibility.

To override the API version, pass the version to the \Stripe\Stripe::setApiVersion() method:

$stripe = new \Stripe\StripeClient([
  "api_key" => "sk_test_4eC39HqLyjWDarjtT1zdp7dc",
  "stripe_version" => "2020-08-27"
]);

Or set it per-request:

$intent = $stripe->paymentIntents->capture(
  'pi_1DhDdc2eZvKYlo2ClEJ6fGTE',
  [],
  ['stripe_version' => '2020-08-27']
);

When overriding it per-request, methods on the returned object reuse the same Stripe version.

You can visit your Dashboard to upgrade your account API version.

Upgrading your server-side library

Minor updates to our libraries are backwards compatible and are generally safe to upgrade to. Major updates often include breaking changes, which may require changes to your code when upgrading. A major version upgrade is sometimes required to use new features.

Before upgrading your API version in the Dashboard, review both the API changelog and the library changelog. 

composer require stripe/stripe-php

This will update the the stripe-php library version in your composer.json file.

/*
 For Gradle, add the following dependency to your build.gradle and replace {VERSION} with
 the version number you want to use from
 - https://mvnrepository.com/artifact/com.stripe/stripe-java or
 - https://github.com/stripe/stripe-java/releases/latest
*/
implementation "com.stripe:stripe-java:{VERSION}"
<!--
  For Maven, add the following dependency to your POM and replace {VERSION} with the
  version number you want to use from
  - https://mvnrepository.com/artifact/com.stripe/stripe-java or
  - https://github.com/stripe/stripe-java/releases/latest
-->
<dependency>
  <groupId>com.stripe</groupId>
  <artifactId>stripe-java</artifactId>
  <version>{VERSION}</version>
</dependency>
# For other environments, manually install the following JARs:
# - The Stripe JAR from https://github.com/stripe/stripe-java/releases/latest
# - Google Gson from https://github.com/google/gson

For more details, check out the API reference or see the source code on GitHub.

Versioning

When backwards-incompatible changes are made to the API, a new, dated version is released. Read our API upgrades guide to see our API changelog and to learn more about backwards compatibility.

Since Java is strongly typed, the version is fixed in the library. Revert to an older version of the library to change the API version used, and create a webhook endpoint with the same API version as Stripe.API_VERSION property in the library. See our stripe-java changelog for the API version required.

You can visit your Dashboard to upgrade your account API version.

Upgrading your server-side library

Minor updates to our libraries are backwards compatible and are generally safe to upgrade to. Major updates often include breaking changes, which may require changes to your code when upgrading. A major version upgrade is sometimes required to use new features.

Upgrading your webhook handlers

During the upgrade process, you should create and maintain two webhook endpoints with two different API versions: one for your existing API version, and one for the API version that you want to upgrade to. This allows you to test your new code while maintaining the ability to safely roll back to your existing version if needed.

  • Write your new event handling code using the version of the library you want to upgrade to. When handling incoming events, store the raw body of the request from Stripe in a queue that is processed sequentially
  • Create a new webhook endpoint with the API version you’re upgrading to and point it at your new code.
curl https://api.stripe.com/v1/webhook_endpoints \
  -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \
  -d url="https://example.com/my/webhook/endpoint" \
  -d "enabled_events[]"="payment_intent.succeeded" \
  -d "enabled_events[]"="payment_intent.payment_failed" \
  -d api_version=2020-03-02


// Set your secret key. Remember to switch to your live secret key in production!
// See your keys here: https://dashboard.stripe.com/account/apikeys
Stripe.apiKey = "sk_test_4eC39HqLyjWDarjtT1zdp7dc";

WebhookEndpointCreateParams params =
  WebhookEndpointCreateParams.builder()
    .setUrl("https://example.com/my/webhook/endpoint")
    .addAllEnabledEvent(Arrays.asList(
      WebhookEndpointCreateParams.EnabledEvent.PAYMENT_INTENT__PAYMENT_FAILED,
      WebhookEndpointCreateParams.EnabledEvent.PAYMENT_INTENT__SUCCEEDED))
    .setApiVersion(WebhookEndpointCreateParams.ApiVersion.VERSION_2019_03_14)
    .build();

WebhookEndpoint.create(params);

// Set your secret key. Remember to switch to your live secret key in production!
// See your keys here: https://dashboard.stripe.com/account/apikeys
stripe.Key = "sk_test_4eC39HqLyjWDarjtT1zdp7dc"

params := &stripe.WebhookEndpointParams{
  URL: stripe.String("https://example.com/my/webhook/endpoint"),
  EnabledEvents: stripe.StringSlice([]string{
    "payment_intent.succeeded",
    "payment_intent.payment_failed",
  }),
  APIVersion: stripe.String("2020-03-02"),
}
we, err := webhookendpoint.New(params)

// Set your secret key. Remember to switch to your live secret key in production!
// See your keys here: https://dashboard.stripe.com/account/apikeys
StripeConfiguration.ApiKey = "sk_test_4eC39HqLyjWDarjtT1zdp7dc";

var options = new WebhookEndpointCreateOptions
{
  Url = "https://example.com/my/webhook/endpoint",
  EnabledEvents = new List<String>
  {
    "payment_intent.succeeded",
    "payment_intent.payment_failed",
  },
  ApiVersion = "2020-03-02",
};
var service = new WebhookEndpointService();
var webhookEndpoint = service.Create(options);
  • Test your new event handling code.
  • When you’re confident your new code works as intended, you can start processing events with your new code and disable or delete your old webhook endpoint.

If you’re not using an event queue, you can modify your old code to stop processing events and respond with a 400 HTTP status code. Then, if the new code isn’t working as expected and you need to revert to the old code, you can turn the event processing logic back on and have it respond normally again. As long as you do so within the three day window, you’ll get all the events retried, and not miss any.

# Install via npm
npm install --save stripe

Usage with TypeScript

Import Stripe as a default import and instantiate it as new Stripe() with the latest API version.

import Stripe from 'stripe';
const stripe = new Stripe('sk_test_4eC39HqLyjWDarjtT1zdp7dc', {
  apiVersion: '2020-08-27',
});

For more details, check out the API reference or see the source code on GitHub.

Versioning

When backwards-incompatible changes are made to the API, a new, dated version is released. Read our API upgrades guide to see our API changelog and to learn more about backwards compatibility.

To override the API version, provide the apiVersion option:

const stripe = require('stripe')('sk_test_4eC39HqLyjWDarjtT1zdp7dc', {
  apiVersion: '2020-08-27',
});

Or set it per-request:

const intent = await stripe.paymentIntents.retrieve('pi_1DhDdc2eZvKYlo2ClEJ6fGTE', {
  apiVersion: '2020-08-27',
});

You can visit your Dashboard to upgrade your account API version.

Upgrading your server-side library

Minor updates to our libraries are backwards compatible and are generally safe to upgrade to. Major updates often include breaking changes, which may require changes to your code when upgrading. A major version upgrade is sometimes required to use new features.

Before upgrading your API version in the Dashboard, review both the API changelog and the library changelog.

For TypeScript users: stripe-node provides types only for the latest API version at the time of release. This version is encoded in the API_VERSION file.

In your project directory update stripe-node to the latest version:

npm install stripe@latest
# Make sure your project is using Go Modules
go mod init
# Install stripe-go
go get -u github.com/stripe/stripe-go/v71
// Then import the package
import (
  "github.com/stripe/stripe-go/v71"
)

For more details, check out the API reference or see the source code on GitHub.

Versioning

When backwards-incompatible changes are made to the API, a new, dated version is released. Read our API upgrades guide to see our API changelog and to learn more about backwards compatibility.

Since Go is strongly typed, the version is fixed in the library. Revert to an older version of the library to change the API version used, and create a webhook endpoint with the same API version as stripe.apiversion property in the library. See our stripe-go changelog for the API version required.

You can visit your Dashboard to upgrade your account API version.

Upgrading your server-side library

Minor updates to our libraries are backwards compatible and are generally safe to upgrade to. Major updates often include breaking changes, which may require changes to your code when upgrading. A major version upgrade is sometimes required to use new features.

Upgrading your webhook handlers

During the upgrade process, you should create and maintain two webhook endpoints with two different API versions: one for your existing API version, and one for the API version that you want to upgrade to. This allows you to test your new code while maintaining the ability to safely roll back to your existing version if needed.

  • Write your new event handling code using the version of the library you want to upgrade to. When handling incoming events, store the raw body of the request from Stripe in a queue that is processed sequentially
  • Create a new webhook endpoint with the API version you’re upgrading to and point it at your new code.
curl https://api.stripe.com/v1/webhook_endpoints \
  -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \
  -d url="https://example.com/my/webhook/endpoint" \
  -d "enabled_events[]"="payment_intent.succeeded" \
  -d "enabled_events[]"="payment_intent.payment_failed" \
  -d api_version=2020-03-02


// Set your secret key. Remember to switch to your live secret key in production!
// See your keys here: https://dashboard.stripe.com/account/apikeys
Stripe.apiKey = "sk_test_4eC39HqLyjWDarjtT1zdp7dc";

WebhookEndpointCreateParams params =
  WebhookEndpointCreateParams.builder()
    .setUrl("https://example.com/my/webhook/endpoint")
    .addAllEnabledEvent(Arrays.asList(
      WebhookEndpointCreateParams.EnabledEvent.PAYMENT_INTENT__PAYMENT_FAILED,
      WebhookEndpointCreateParams.EnabledEvent.PAYMENT_INTENT__SUCCEEDED))
    .setApiVersion(WebhookEndpointCreateParams.ApiVersion.VERSION_2019_03_14)
    .build();

WebhookEndpoint.create(params);

// Set your secret key. Remember to switch to your live secret key in production!
// See your keys here: https://dashboard.stripe.com/account/apikeys
stripe.Key = "sk_test_4eC39HqLyjWDarjtT1zdp7dc"

params := &stripe.WebhookEndpointParams{
  URL: stripe.String("https://example.com/my/webhook/endpoint"),
  EnabledEvents: stripe.StringSlice([]string{
    "payment_intent.succeeded",
    "payment_intent.payment_failed",
  }),
  APIVersion: stripe.String("2020-03-02"),
}
we, err := webhookendpoint.New(params)

// Set your secret key. Remember to switch to your live secret key in production!
// See your keys here: https://dashboard.stripe.com/account/apikeys
StripeConfiguration.ApiKey = "sk_test_4eC39HqLyjWDarjtT1zdp7dc";

var options = new WebhookEndpointCreateOptions
{
  Url = "https://example.com/my/webhook/endpoint",
  EnabledEvents = new List<String>
  {
    "payment_intent.succeeded",
    "payment_intent.payment_failed",
  },
  ApiVersion = "2020-03-02",
};
var service = new WebhookEndpointService();
var webhookEndpoint = service.Create(options);
  • Test your new event handling code.
  • When you’re confident your new code works as intended, you can start processing events with your new code and disable or delete your old webhook endpoint.

If you’re not using an event queue, you can modify your old code to stop processing events and respond with a 400 HTTP status code. Then, if the new code isn’t working as expected and you need to revert to the old code, you can turn the event processing logic back on and have it respond normally again. As long as you do so within the three day window, you’ll get all the events retried, and not miss any.

# Install via dotnet
dotnet add package Stripe.net
dotnet restore
# Or install via NuGet
PM> Install-Package Stripe.net

For more details, check out the API reference or see the source code on GitHub.

Versioning

When backwards-incompatible changes are made to the API, a new, dated version is released. Read our API upgrades guide to see our API changelog and to learn more about backwards compatibility.

Since C# is strongly typed, the version is fixed in the library. Revert to an older version of the library to change the API version used, and create a webhook endpoint with the same API version as StripeConfiguration.ApiVersion property in the library. See our stripe-dotnet changelog for the API version required.

You can visit your Dashboard to upgrade your account API version.

Upgrading your server-side library

Minor updates to our libraries are backwards compatible and are generally safe to upgrade to. Major updates often include breaking changes, which may require changes to your code when upgrading. A major version upgrade is sometimes required to use new features.

Upgrading your webhook handlers

During the upgrade process, you should create and maintain two webhook endpoints with two different API versions: one for your existing API version, and one for the API version that you want to upgrade to. This allows you to test your new code while maintaining the ability to safely roll back to your existing version if needed.

  • Write your new event handling code using the version of the library you want to upgrade to. When handling incoming events, store the raw body of the request from Stripe in a queue that is processed sequentially
  • Create a new webhook endpoint with the API version you’re upgrading to and point it at your new code.
curl https://api.stripe.com/v1/webhook_endpoints \
  -u sk_test_4eC39HqLyjWDarjtT1zdp7dc: \
  -d url="https://example.com/my/webhook/endpoint" \
  -d "enabled_events[]"="payment_intent.succeeded" \
  -d "enabled_events[]"="payment_intent.payment_failed" \
  -d api_version=2020-03-02


// Set your secret key. Remember to switch to your live secret key in production!
// See your keys here: https://dashboard.stripe.com/account/apikeys
Stripe.apiKey = "sk_test_4eC39HqLyjWDarjtT1zdp7dc";

WebhookEndpointCreateParams params =
  WebhookEndpointCreateParams.builder()
    .setUrl("https://example.com/my/webhook/endpoint")
    .addAllEnabledEvent(Arrays.asList(
      WebhookEndpointCreateParams.EnabledEvent.PAYMENT_INTENT__PAYMENT_FAILED,
      WebhookEndpointCreateParams.EnabledEvent.PAYMENT_INTENT__SUCCEEDED))
    .setApiVersion(WebhookEndpointCreateParams.ApiVersion.VERSION_2019_03_14)
    .build();

WebhookEndpoint.create(params);

// Set your secret key. Remember to switch to your live secret key in production!
// See your keys here: https://dashboard.stripe.com/account/apikeys
stripe.Key = "sk_test_4eC39HqLyjWDarjtT1zdp7dc"

params := &stripe.WebhookEndpointParams{
  URL: stripe.String("https://example.com/my/webhook/endpoint"),
  EnabledEvents: stripe.StringSlice([]string{
    "payment_intent.succeeded",
    "payment_intent.payment_failed",
  }),
  APIVersion: stripe.String("2020-03-02"),
}
we, err := webhookendpoint.New(params)

// Set your secret key. Remember to switch to your live secret key in production!
// See your keys here: https://dashboard.stripe.com/account/apikeys
StripeConfiguration.ApiKey = "sk_test_4eC39HqLyjWDarjtT1zdp7dc";

var options = new WebhookEndpointCreateOptions
{
  Url = "https://example.com/my/webhook/endpoint",
  EnabledEvents = new List<String>
  {
    "payment_intent.succeeded",
    "payment_intent.payment_failed",
  },
  ApiVersion = "2020-03-02",
};
var service = new WebhookEndpointService();
var webhookEndpoint = service.Create(options);
  • Test your new event handling code.
  • When you’re confident your new code works as intended, you can start processing events with your new code and disable or delete your old webhook endpoint.

If you’re not using an event queue, you can modify your old code to stop processing events and respond with a 400 HTTP status code. Then, if the new code isn’t working as expected and you need to revert to the old code, you can turn the event processing logic back on and have it respond normally again. As long as you do so within the three day window, you’ll get all the events retried, and not miss any.

Was this page helpful?
Questions? Contact us.
Developer tutorials on YouTube.
You can unsubscribe at any time. Read our privacy policy.