Introduction to server-side SDKs

Stripe’s server-side SDKs reduce the amount of work required to use Stripe’s REST APIs. Stripe-maintained SDKs are available for Ruby, PHP, Java, Python, Node, .NET and Go. Community libraries are also available for other server languages.

Installation and setup

Select your language in the language selector below, then follow the instructions to install the SDK.

# Available as a gem
sudo gem install stripe

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

After completing the installation, you need to initialize Stripe:

require 'stripe'
Stripe.api_key = 
'sk_test_4eC39HqLyjWDarjtT1zdp7dc'

Send API requests

There are six main ways to manipulate objects with the Stripe API: create, update, delete, retrieve, list, and search. Here are some examples of this with the Customer object:

curl https://api.stripe.com/v1/customers \
  -u "
sk_test_4eC39HqLyjWDarjtT1zdp7dc
:" \
  -d name="John Doe"

API requests can contain different types of parameters. For example, here’s how to create a customer with a name (a string), address (an object), and preferred_locales (a list):

curl https://api.stripe.com/v1/customers \
  -u "
sk_test_4eC39HqLyjWDarjtT1zdp7dc
:" \
  -d name="John Doe" \
  -d "address[country]"=US \
  -d "address[city]"="San Fransisco" \
  -d "preferred_locales[]"=EN \
  -d "preferred_locales[]"=FR

When updating an object, you can clear some of its properties. For dynamically typed languages, send an empty string. For strongly typed languages, use specific constants. For example, here’s how to clear the name (a string) and metadata (a hash of key-value pairs) of a customer:

customer = Stripe::Customer.update(
'{{CUSTOMER_ID}}', {
  name: '',
  metadata: '',
})

This example clears all metadata, but you can also clear individual keys. Learn more about managing metadata in our metadata guide.

Access the API response

Every time you make an API request, Stripe sends you back a response.

If you create, retrieve, or update an object, you get back the object itself:

{
  "id": "pi_001",
  "object": "payment_intent",
  "amount": 1099,
  "currency": "usd",
  /* ... */
}

Use a variable to access the properties of that object:

paymentIntent = Stripe::PaymentIntent.retrieve('{{PAYMENT_INTENT_ID}}')
puts paymentIntent.amount

When listing or searching for objects, you get back a List object containing a data array with the objects requested:

{
  "object": "list",
  "data": [
    {
      "id": "pi_003",
      "object": "payment_intent",
      "amount": 4200,
      "currency": "usd",
      /* ... */
    },
    {
      "id": "pi_002",
      "object": "payment_intent",
      "amount": 2100,
      "currency": "usd",
      "payment_method_types": [ "link" ],
      /* ... */
    }
  ],
  "has_more": true,
  "url": "/v1/payment_intents"
}

Use a loop on the data array to access the properties of each object:

paymentIntentList = Stripe::PaymentIntent.list({ limit: 3 })
for pi in paymentIntentList.data do
  puts pi.amount
end

You could also use auto-pagination to iterate over all the results.

Expanding responses

Some properties are expandable or includable, meaning you can return them by using the expand parameter. For example:

• Retrieve a PaymentIntent and expand its associated PaymentMethod.
  Command Line

  cURL

  curl -G https://api.stripe.com/v1/payment_intents/{{PAYMENT_INTENT_ID}} \
    -u "
  sk_test_4eC39HqLyjWDarjtT1zdp7dc
  :" \
    -d "expand[]"=payment_method

• Retrieve a Checkout Session and include the line_items property.
  Command Line

  cURL

  curl -G https://api.stripe.com/v1/checkout/sessions/{{SESSION_ID}} \
    -u "
  sk_test_4eC39HqLyjWDarjtT1zdp7dc
  :" \
    -d "expand[]"=line_items

Learn more about expanding responses.

Retrieve the request ID

Each API request has a unique request ID (req_xxx) associated with it. This is useful to inspect the request in the Dashboard to see the parameters Stripe received, or to share it with Stripe support when facing an issue.

You can find the IDs in your Dashboard logs, or directly with code like this:

customer = Stripe::Customer.create({ name: 'John Doe', })
puts customer.last_response.request_id

Set additional request options

When sending an API requests, you can set additional request options to:

• Set a specific API version.
• Make requests on your connected accounts.
• Provide idempotency keys.

エラー処理

Each server SDK interprets error responses from the Stripe API as exception types, so you don’t need to parse the response status yourself. Use error handling conventions appropriate for each language to handle those errors.

begin
  Stripe::PaymentIntent.create(params)
rescue Stripe::CardError => e
  puts "A payment error occurred: #{e.error.message}"
rescue Stripe::InvalidRequestError => e
  puts "An invalid request occurred."
rescue Stripe::StripeError => e
  puts "Another problem occurred, maybe unrelated to Stripe."
else
  puts "No error."
end

Learn more about error handling.

Private preview features

Stripe regularly launches private preview features which introduce new properties or parameters that are not immediately public. Dynamically-typed SDKs (PHP, Node, Ruby, Python) automatically support these. For strongly-typed SDKs (Java, .NET, Go), use the code below, unless they’re supported in a beta release.

Send undocumented parameters:

CustomerCreateParams params =
  CustomerCreateParams.builder()
    .setEmail("jenny.rosen@example.com")
    .putExtraParam("secret_feature_enabled", "true")
    .build();

client.customers().create(params);

Access undocumented fields:

final Customer customer = client.customers().retrieve("cus_1234");
Boolean featureEnabled = customer.getRawJsonObject()
    .getAsJsonPrimitive("secret_feature_enabled")
    .getAsBoolean();

Source code

The source code for each of our server SDKs is available on GitHub:

Client & service patterns

For some SDKs, we’ve introduced a client/service pattern that changes the way you perform operations. This new service-based pattern allows for easier mocking without static methods and enables multiple client instances to operate simultaneously with distinct configuration.

If you’re comparing code targeting older versions of these libraries with resource-based patterns, the calls might look different.

ベータバージョン

We offer beta SDKs that are identifiable by the beta or b filename suffix, such as 5.1.0-beta.3 or 5.1.0b3. They give you access to products and features in development, and allow you to share feedback with us before their general availability.

Access the beta SDK releases through the readme.md file of the respective GitHub repository.