Sample - Stripe API
POST/v1/checkout/sessions

Create a Checkout Session

Creates a Checkout Session for a one-time purchase or subscription. Supply the session configuration, including its mode, payment settings, line items, customer information, and redirect behaviour as applicable. A 200 response returns the created session for use in the Checkout flow.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

51 body fields

Checkout Session configuration for payment, subscription, customer collection, branding, line items, tax, consent, and related options.

adaptive_pricingobjectoptional
Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
after_expirationobjectoptional
Configure actions after a Checkout Session has expired. You can't set this parameter if `ui_mode` is `elements`.
allow_promotion_codesbooleanoptional
Enables user redeemable promotion codes.
automatic_taxobjectoptional
Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
billing_address_collectionstringoptional
Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.
Allowed:autorequired
branding_settingsobjectoptional
The branding settings for the Checkout Session. This parameter is not allowed if ui_mode is `elements`.
cancel_urlstringoptional
If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is `embedded_page` or `elements`.
client_reference_idstringoptional
A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the session with your internal systems.
consent_collectionobjectoptional
Configure fields for the Checkout Session to gather active consent from customers.
currencystringoptional
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Required in `setup` mode when `payment_method_types` is not set.
custom_fieldsarray<CustomFieldParam>optional
Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if `ui_mode` is `custom`.
custom_textobjectoptional
Display additional text for your customers using custom text. You can't set this parameter if `ui_mode` is `custom`.
customerstringoptional
ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card payment method will be used to prefill the email, name, card details, and billing address on the Checkout page. In `subscription` mode, the customer’s [default payment method](https://docs.stripe.com/api/customers/update#update_customer-invoice_settings-default_payment_method) will be used if it’s a card, otherwise the most recently saved card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer's card details. If the Customer already has a valid [email](https://docs.stripe.com/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout. If the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer. If blank for Checkout Sessions in `subscription` mode or with `customer_creation` set as `always` in `payment` mode, Checkout will create a new Customer object based on information provided during the payment flow. You can set [`payment_intent_data.setup_future_usage`](https://docs.stripe.com/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.
customer_accountstringoptional
ID of an existing Account, if one exists. Has the same behavior as `customer`.
customer_creationstringoptional
Configure whether a Checkout Session creates a [Customer](https://docs.stripe.com/api/customers) during Session confirmation. When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout with [customer_details](https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-customer_details). Sessions that don't create Customers instead are grouped by [guest customers](https://docs.stripe.com/payments/checkout/guest-customers) in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions. Can only be set in `payment` and `setup` mode.
Allowed:alwaysif_required
customer_emailstringoptional
If provided, this value will be used when the Customer object is created. If not provided, customers will be asked to enter their email address. Use this parameter to prefill customer data if you already have an email on file. To access information about the customer once a session is complete, use the `customer` field.
customer_updateobjectoptional
Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.
discountsarray<DiscountParams>optional
The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
excluded_payment_method_typesarray<string>optional
A list of the types of payment methods (e.g., `card`) that should be excluded from this Checkout Session. This should only be used when payment methods for this Checkout Session are managed through the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
expandarray<string>optional
Specifies which fields in the response should be expanded.
expires_atintegeroptional
The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation.
integration_identifierstringoptional
The integration identifier for this Checkout Session. Multiple Checkout Sessions can have the same integration identifier.
invoice_creationobjectoptional
Generate a post-purchase Invoice for one-time payments.
line_itemsarray<LineItemParams>optional
A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://docs.stripe.com/api/prices). The parameter is required for `payment` and `subscription` mode. For `payment` mode, there is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen. For `subscription` mode, there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices will be on the initial invoice only.
localestringoptional
The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
Allowed:autobgcsdadeelenen-GBeses-419etfi
managed_paymentsobjectoptional
Settings for Managed Payments for this Checkout Session and resulting [PaymentIntents](/api/payment_intents/object), [Invoices](/api/invoices/object), and [Subscriptions](/api/subscriptions/object).
metadataobjectoptional
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
modestringoptional
The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.
Allowed:paymentsetupsubscription
name_collectionobjectoptional
Controls name collection settings for the session. You can configure Checkout to collect your customers' business names, individual names, or both. Each name field can be either required or optional. If a [Customer](https://docs.stripe.com/api/customers) is created or provided, the names can be saved to the Customer object as well.
optional_itemsarray<OptionalItemParams>optional
A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://docs.stripe.com/api/prices). There is a maximum of 10 optional items allowed on a Checkout Session, and the existing limits on the number of line items allowed on a Checkout Session apply to the combined number of line items and optional items. For `payment` mode, there is a maximum of 100 combined line items and optional items, however it is recommended to consolidate items if there are more than a few dozen. For `subscription` mode, there is a maximum of 20 line items and optional items with recurring Prices and 20 line items and optional items with one-time Prices. You can't set this parameter if `ui_mode` is `custom`.
origin_contextstringoptional
Where the user is coming from. This informs the optimizations that are applied to the session. You can't set this parameter if `ui_mode` is `elements`.
Allowed:mobile_appweb
payment_intent_dataobjectoptional
A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
payment_method_collectionstringoptional
Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0. This may occur if the Checkout Session includes a free trial or a discount. Can only be set in `subscription` mode. Defaults to `always`. If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://docs.stripe.com/payments/checkout/free-trials).
Allowed:alwaysif_required
payment_method_configurationstringoptional
The ID of the payment method configuration to use with this Checkout session.
payment_method_dataobjectoptional
This parameter allows you to set some attributes on the payment method created during a Checkout session.
payment_method_optionsobjectoptional
Payment-method-specific configuration.
payment_method_typesarray<string>optional
A list of the types of payment methods (e.g., `card`) this Checkout Session can accept. You can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). See [Dynamic Payment Methods](https://docs.stripe.com/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details. Read more about the supported payment methods and their requirements in our [payment method details guide](/docs/payments/checkout/payment-methods). If multiple payment methods are passed, Checkout will dynamically reorder them to prioritize the most relevant payment methods based on the customer's location and other characteristics.
permissionsobjectoptional
This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object. Can only be set when creating `embedded` or `custom` sessions. For specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`.
phone_number_collectionobjectoptional
Controls phone number collection settings for the session. We recommend that you review your privacy policy and check with your legal contacts before using this feature. Learn more about [collecting phone numbers with Checkout](https://docs.stripe.com/payments/checkout/phone-numbers).
redirect_on_completionstringoptional
This parameter applies to `ui_mode: embedded_page`. Learn more about the [redirect behavior](https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.
Allowed:alwaysif_requirednever
return_urlstringoptional
The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. This parameter is required if `ui_mode` is `embedded_page` or `elements` and redirect-based payment methods are enabled on the session.
saved_payment_method_optionsobjectoptional
Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
setup_intent_dataobjectoptional
A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.
shipping_address_collectionobjectoptional
When set, provides configuration for Checkout to collect a shipping address from a customer.
shipping_optionsarray<ShippingOptionParams>optional
The shipping rate options to apply to this Session. Up to a maximum of 5.
submit_typestringoptional
Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the submit button. `submit_type` can only be specified on Checkout Sessions in `payment` or `subscription` mode. If blank or `auto`, `pay` is used. You can't set this parameter if `ui_mode` is `elements`.
Allowed:autobookdonatepaysubscribe
subscription_dataobjectoptional
A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
success_urlstringoptional
The URL to which Stripe should send customers when payment or setup is complete. This parameter is not allowed if ui_mode is `embedded_page` or `elements`. If you'd like to use information from the successful Checkout Session on your page, read the guide on [customizing your success page](https://docs.stripe.com/payments/checkout/custom-success-page).
tax_id_collectionobjectoptional
Controls tax ID collection during checkout.
ui_modestringoptional
The UI mode of the Session. Defaults to `hosted_page`.
Allowed:elementsembedded_pagehosted_page
wallet_optionsobjectoptional
Wallet-specific configuration.

2 status codes
200Returns the created Checkout Session object, including its identifier, mode, payment status, expiration time, payment method types, totals, and customer-facing configuration.
adaptive_pricingobjectoptional
Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
after_expirationobjectoptional
When set, provides configuration for actions to take if this Checkout Session expires.
allow_promotion_codesbooleanoptional
Enables user redeemable promotion codes.
amount_subtotalintegeroptional
Total of all items before discounts or taxes are applied.
amount_totalintegeroptional
Total of all items after discounts and taxes are applied.
automatic_taxobjectrequired
billing_address_collectionstringoptional
Describes whether Checkout should collect the customer's billing address. Defaults to `auto`.
Allowed:autorequired
branding_settingsobjectoptional
cancel_urlstringoptional
If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.
client_reference_idstringoptional
A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the Session with your internal systems.
client_secretstringoptional
The client secret of your Checkout Session. Applies to Checkout Sessions with `ui_mode: embedded_page` or `ui_mode: elements`. For `ui_mode: embedded_page`, the client secret is to be used when initializing Stripe.js embedded checkout. For `ui_mode: elements`, use the client secret with [initCheckout](https://docs.stripe.com/js/custom_checkout/init) on your front end.
collected_informationobjectoptional
Information about the customer collected within the Checkout Session.
consentobjectoptional
Results of `consent_collection` for this session.
consent_collectionobjectoptional
When set, provides configuration for the Checkout Session to gather active consent from customers.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
currencystringoptional
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
currency_conversionobjectoptional
Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions created before 2025-03-31.
custom_fieldsarray<PaymentPagesCheckoutSessionCustomFields>required
Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if `ui_mode` is `custom`.
custom_textobjectrequired
customerstringoptional
The ID of the customer for this Session. For Checkout Sessions in `subscription` mode or Checkout Sessions with `customer_creation` set as `always` in `payment` mode, Checkout will create a new customer object based on information provided during the payment flow unless an existing customer was provided when the Session was created.
customer_accountstringoptional
The ID of the account for this Session.
customer_creationstringoptional
Configure whether a Checkout Session creates a Customer when the Checkout Session completes.
Allowed:alwaysif_required
customer_detailsobjectoptional
The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode.
customer_emailstringoptional
If provided, this value will be used when the Customer object is created. If not provided, customers will be asked to enter their email address. Use this parameter to prefill customer data if you already have an email on file. To access information about the customer once the payment flow is complete, use the `customer` attribute.
discountsarray<PaymentPagesCheckoutSessionDiscount>optional
List of coupons and promotion codes attached to the Checkout Session.
excluded_payment_method_typesarray<string>optional
A list of the types of payment methods (e.g., `card`) that should be excluded from this Checkout Session. This should only be used when payment methods for this Checkout Session are managed through the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
expires_atintegerrequired
The timestamp at which the Checkout Session will expire.
idstringrequired
Unique identifier for the object.
integration_identifierstringoptional
The integration identifier for this Checkout Session. Multiple Checkout Sessions can have the same integration identifier.
invoicestringoptional
ID of the invoice created by the Checkout Session, if it exists.
invoice_creationobjectoptional
Details on the state of invoice creation for the Checkout Session.
line_itemsobjectoptional
The line items purchased by the customer.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
localestringoptional
The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
Allowed:autobgcsdadeelenen-GBeses-419etfi
managed_paymentsobjectoptional
Settings for Managed Payments for this Checkout Session and resulting [PaymentIntents](/api/payment_intents/object), [Invoices](/api/invoices/object), and [Subscriptions](/api/subscriptions/object).
metadataobjectoptional
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
modestringrequired
The mode of the Checkout Session.
Allowed:paymentsetupsubscription
name_collectionobjectoptional
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:checkout.session
optional_itemsarray<PaymentPagesCheckoutSessionOptionalItem>optional
The optional items presented to the customer at checkout.
origin_contextstringoptional
Where the user is coming from. This informs the optimizations that are applied to the session.
Allowed:mobile_appweb
payment_intentstringoptional
The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://docs.stripe.com/api/checkout/sessions/expire) instead.
payment_linkstringoptional
The ID of the Payment Link that created this Session.
payment_method_collectionstringoptional
Configure whether a Checkout Session should collect a payment method for sessions with mode `payment`. Defaults to `always`.
Allowed:alwaysif_required
payment_method_configuration_detailsobjectoptional
Information about the payment method configuration used for this Checkout session if using dynamic payment methods.
payment_method_optionsobjectoptional
Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.
payment_method_typesarray<string>required
A list of the types of payment methods (e.g. card) this Checkout Session is allowed to accept.
payment_statusstringrequired
The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`. You can use this value to decide when to fulfill your customer's order.
Allowed:no_payment_requiredpaidunpaid
permissionsobjectoptional
This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object. For specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`.
phone_number_collectionobjectoptional
presentment_detailsobjectoptional
recovered_fromstringoptional
The ID of the original expired Checkout Session that triggered the recovery flow.
redirect_on_completionstringoptional
This parameter applies to `ui_mode: embedded_page`. Learn more about the [redirect behavior](https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.
Allowed:alwaysif_requirednever
return_urlstringoptional
Applies to Checkout Sessions with `ui_mode: embedded_page` or `ui_mode: elements`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.
saved_payment_method_optionsobjectoptional
Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
setup_intentstringoptional
The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://docs.stripe.com/api/checkout/sessions/expire) instead.
shipping_address_collectionobjectoptional
When set, provides configuration for Checkout to collect a shipping address from a customer.
shipping_costobjectoptional
The details of the customer cost of shipping, including the customer chosen ShippingRate.
shipping_optionsarray<PaymentPagesCheckoutSessionShippingOption>required
The shipping rate options applied to this Session.
statusstringoptional
The status of the Checkout Session, one of `open`, `complete`, or `expired`.
Allowed:completeexpiredopen
submit_typestringoptional
Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the submit button. `submit_type` can only be specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.
Allowed:autobookdonatepaysubscribe
subscriptionstringoptional
The ID of the [Subscription](https://docs.stripe.com/api/subscriptions) for Checkout Sessions in `subscription` mode.
success_urlstringoptional
The URL the customer will be directed to after the payment or subscription creation is successful.
tax_id_collectionobjectoptional
total_detailsobjectoptional
Tax and discount details for the computed total amount.
ui_modestringoptional
The UI mode of the Session. Defaults to `hosted_page`.
Allowed:elementsembedded_pagehosted_page
urlstringoptional
The URL to the Checkout Session. Applies to Checkout Sessions with `ui_mode: hosted_page`. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://docs.stripe.com/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.` This value is only present when the session is active.
wallet_optionsobjectoptional
Wallet-specific configuration for this Checkout Session.
defaultReturned when the Checkout Session configuration cannot be processed because a supplied field or nested configuration is invalid.
errorobjectrequired

Error handling

currency must be a supported lowercase ISO currency code when supplied, and customer_creation must be always or if_required. billing_address_collection accepts auto or required, while consent_collection.terms_of_service accepts none or required. client_reference_id must not exceed 200 characters, and nested objects must include their schema-defined fields such as automatic_tax.enabled and custom_fields.key, label, and type.