Stripe: Create a Checkout Session

Stripe checkout.postCheckoutSessions: arguments, response, policy and SDK examples.

Operation stripe.postcheckoutsessions

Provider route: POST /v1/checkout/sessions. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";

async function execute(input: Parameters<StripeIntegration["checkout"]["postCheckoutSessions"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.checkout.postCheckoutSessions(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.checkout.post_checkout_sessions(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`headers`	object	Optional	Additional keys: not allowed
`headers.Idempotency-Key`	string	Optional	Minimum length: 1 Maximum length: 255
`body`	object	Optional	Additional keys: not allowed
`body.adaptive_pricing`	object	Optional	Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
`body.adaptive_pricing.enabled`	boolean	Optional
`body.after_expiration`	object	Optional	Configure actions after a Checkout Session has expired. You can’t set this parameter if `ui_mode` is `elements`.
`body.after_expiration.recovery`	object	Optional
`body.after_expiration.recovery.allow_promotion_codes`	boolean	Optional
`body.after_expiration.recovery.enabled`	boolean	Required within parent
`body.allow_promotion_codes`	boolean	Optional	Enables user redeemable promotion codes.
`body.allowed_payment_method_types`	array	Optional	A list of the types of payment methods (e.g., `card`) this Checkout Session can accept. Unlike `payment_method_types`, this acts as a filter on the dynamically computed set of eligible payment methods rather than an explicit static list. Only payment methods that are both dynamically eligible and present in this list will be offered to the customer.
`body.allowed_payment_method_types[]`	string	Each item	One of: acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip
`body.automatic_tax`	object	Optional	Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
`body.automatic_tax.enabled`	boolean	Required within parent
`body.automatic_tax.liability`	object	Optional
`body.automatic_tax.liability.account`	string	Optional
`body.automatic_tax.liability.type`	string	Required within parent	One of: account, self
`body.billing_address_collection`	string	Optional	Specify whether Checkout should collect the customer’s billing address. Defaults to `auto`. One of: auto, required
`body.branding_settings`	object	Optional	The branding settings for the Checkout Session. This parameter is not allowed if ui_mode is `elements`.
`body.branding_settings.background_color`	JSON	Optional
`body.branding_settings.background_color (anyOf 1)`	string	Alternative	Maximum length: 5000
`body.branding_settings.background_color (anyOf 2)`	string	Alternative	One of:
`body.branding_settings.border_style`	string	Optional	One of: , pill, rectangular, rounded
`body.branding_settings.button_color`	JSON	Optional
`body.branding_settings.button_color (anyOf 1)`	string	Alternative	Maximum length: 5000
`body.branding_settings.button_color (anyOf 2)`	string	Alternative	One of:
`body.branding_settings.display_name`	string	Optional	Maximum length: 5000
`body.branding_settings.font_family`	string	Optional	One of: , be_vietnam_pro, bitter, chakra_petch, default, hahmlet, inconsolata, inter, lato, lora, m_plus_1_code, montserrat, noto_sans, noto_sans_jp, noto_serif, nunito, open_sans, pridi, pt_sans, pt_serif, raleway, roboto, roboto_slab, source_sans_pro, titillium_web, ubuntu_mono, zen_maru_gothic
`body.branding_settings.icon`	object	Optional
`body.branding_settings.icon.file`	string	Optional
`body.branding_settings.icon.type`	string	Required within parent	One of: file, url
`body.branding_settings.icon.url`	string	Optional
`body.branding_settings.logo`	object	Optional
`body.branding_settings.logo.file`	string	Optional
`body.branding_settings.logo.type`	string	Required within parent	One of: file, url
`body.branding_settings.logo.url`	string	Optional
`body.cancel_url`	string	Optional	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`.
`body.client_reference_id`	string	Optional	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. Maximum length: 200
`body.consent_collection`	object	Optional	Configure fields for the Checkout Session to gather active consent from customers.
`body.consent_collection.payment_method_reuse_agreement`	object	Optional
`body.consent_collection.payment_method_reuse_agreement.position`	string	Required within parent	One of: auto, hidden
`body.consent_collection.promotions`	string	Optional	One of: auto, none
`body.consent_collection.terms_of_service`	string	Optional	One of: none, required
`body.currency`	string	Optional	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. Format: currency
`body.custom_fields`	array	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 `elements`.
`body.custom_fields[]`	Model	Each item	Expand Create a payment link — request body — body custom fields item
`body.custom_text`	Model	Optional	Expand Create a payment link — request body — body custom text
`body.customer`	string	Optional	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. Maximum length: 5000
`body.customer_account`	string	Optional	ID of an existing Account, if one exists. Has the same behavior as `customer`. Maximum length: 5000
`body.customer_creation`	string	Optional	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. One of: always, if_required
`body.customer_email`	string	Optional	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.
`body.customer_update`	object	Optional	Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.
`body.customer_update.address`	string	Optional	One of: auto, never
`body.customer_update.name`	string	Optional	One of: auto, never
`body.customer_update.shipping`	string	Optional	One of: auto, never
`body.discounts`	array	Optional	The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
`body.discounts[]`	object	Each item
`body.discounts[].coupon`	string	Optional	Maximum length: 5000
`body.discounts[].promotion_code`	string	Optional	Maximum length: 5000
`body.excluded_payment_method_types`	array	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).
`body.excluded_payment_method_types[]`	string	Each item	One of: acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, kakao_pay, klarna, konbini, kr_card, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip
`body.expand`	array	Optional	Specifies which fields in the response should be expanded.
`body.expand[]`	string	Each item	Maximum length: 5000
`body.expires_at`	integer	Optional	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. Format: unix-time
`body.integration_identifier`	string	Optional	The integration identifier for this Checkout Session. Multiple Checkout Sessions can have the same integration identifier. Maximum length: 200
`body.invoice_creation`	object	Optional	Generate a post-purchase Invoice for one-time payments.
`body.invoice_creation.enabled`	boolean	Required within parent
`body.invoice_creation.invoice_data`	object	Optional
`body.invoice_creation.invoice_data.account_tax_ids`	JSON	Optional
`body.invoice_creation.invoice_data.account_tax_ids (anyOf 1)`	array	Alternative
`body.invoice_creation.invoice_data.account_tax_ids (anyOf 1)[]`	string	Each item	Maximum length: 5000
`body.invoice_creation.invoice_data.account_tax_ids (anyOf 2)`	string	Alternative	One of:
`body.invoice_creation.invoice_data.custom_fields`	JSON	Optional
`body.invoice_creation.invoice_data.custom_fields (anyOf 1)`	array	Alternative
`body.invoice_creation.invoice_data.custom_fields (anyOf 1)[]`	object	Each item
`body.invoice_creation.invoice_data.custom_fields (anyOf 1)[].name`	string	Required within parent	Maximum length: 40
`body.invoice_creation.invoice_data.custom_fields (anyOf 1)[].value`	string	Required within parent	Maximum length: 140
`body.invoice_creation.invoice_data.custom_fields (anyOf 2)`	string	Alternative	One of:
`body.invoice_creation.invoice_data.description`	string	Optional	Maximum length: 1500
`body.invoice_creation.invoice_data.footer`	string	Optional	Maximum length: 5000
`body.invoice_creation.invoice_data.issuer`	object	Optional
`body.invoice_creation.invoice_data.issuer.account`	string	Optional
`body.invoice_creation.invoice_data.issuer.type`	string	Required within parent	One of: account, self
`body.invoice_creation.invoice_data.metadata`	object	Optional	Additional keys: see wildcard field
`body.invoice_creation.invoice_data.metadata.*`	string	Additional keys
`body.invoice_creation.invoice_data.rendering_options`	JSON	Optional
`body.invoice_creation.invoice_data.rendering_options (anyOf 1)`	object	Alternative
`body.invoice_creation.invoice_data.rendering_options (anyOf 1).amount_tax_display`	string	Optional	One of: , exclude_tax, include_inclusive_tax
`body.invoice_creation.invoice_data.rendering_options (anyOf 1).template`	string	Optional	Maximum length: 5000
`body.invoice_creation.invoice_data.rendering_options (anyOf 2)`	string	Alternative	One of:
`body.line_items`	array	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.
`body.line_items[]`	object	Each item
`body.line_items[].adjustable_quantity`	object	Optional
`body.line_items[].adjustable_quantity.enabled`	boolean	Required within parent
`body.line_items[].adjustable_quantity.maximum`	integer	Optional
`body.line_items[].adjustable_quantity.minimum`	integer	Optional
`body.line_items[].metadata`	object	Optional	Additional keys: see wildcard field
`body.line_items[].metadata.*`	string	Additional keys
`body.line_items[].price`	string	Optional	Maximum length: 5000
`body.line_items[].price_data`	Model	Optional	Expand Create a payment link — request body — body line items item price data
`body.line_items[].quantity`	integer	Optional
`body.line_items[].tax_rates`	array	Optional
`body.line_items[].tax_rates[]`	string	Each item	Maximum length: 5000
`body.locale`	string	Optional	The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser’s locale is used. One of: auto, bg, cs, da, de, el, en, en-GB, es, es-419, et, fi, fil, fr, fr-CA, hr, hu, id, it, ja, ko, lt, lv, ms, mt, nb, nl, pl, pt, pt-BR, ro, ru, sk, sl, sv, th, tr, vi, zh, zh-HK, zh-TW
`body.managed_payments`	object	Optional	Settings for Managed Payments for this Checkout Session and resulting [PaymentIntents](/api/payment_intents/object), [Invoices](/api/invoices/object), and [Subscriptions](/api/subscriptions/object).
`body.managed_payments.enabled`	boolean	Optional
`body.metadata`	object	Optional	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`. Additional keys: see wildcard field
`body.metadata.*`	string	Additional keys
`body.mode`	string	Optional	The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item. One of: payment, setup, subscription
`body.name_collection`	object	Optional	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.
`body.name_collection.business`	object	Optional
`body.name_collection.business.enabled`	boolean	Required within parent
`body.name_collection.business.optional`	boolean	Optional
`body.name_collection.individual`	object	Optional
`body.name_collection.individual.enabled`	boolean	Required within parent
`body.name_collection.individual.optional`	boolean	Optional
`body.optional_items`	array	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 `elements` or `form`.
`body.optional_items[]`	object	Each item
`body.optional_items[].adjustable_quantity`	object	Optional
`body.optional_items[].adjustable_quantity.enabled`	boolean	Required within parent
`body.optional_items[].adjustable_quantity.maximum`	integer	Optional
`body.optional_items[].adjustable_quantity.minimum`	integer	Optional
`body.optional_items[].price`	string	Required within parent	Maximum length: 5000
`body.optional_items[].quantity`	integer	Required within parent
`body.origin_context`	string	Optional	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`. One of: mobile_app, web
`body.payment_intent_data`	object	Optional	A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
`body.payment_intent_data.application_fee_amount`	integer	Optional
`body.payment_intent_data.capture_method`	string	Optional	One of: automatic, automatic_async, manual
`body.payment_intent_data.description`	string	Optional	Maximum length: 1000
`body.payment_intent_data.metadata`	object	Optional	Additional keys: see wildcard field
`body.payment_intent_data.metadata.*`	string	Additional keys
`body.payment_intent_data.on_behalf_of`	string	Optional
`body.payment_intent_data.receipt_email`	string	Optional
`body.payment_intent_data.setup_future_usage`	string	Optional	One of: off_session, on_session
`body.payment_intent_data.shipping`	object	Optional
`body.payment_intent_data.shipping.address`	object	Required within parent
`body.payment_intent_data.shipping.address.city`	string	Optional	Maximum length: 5000
`body.payment_intent_data.shipping.address.country`	string	Optional	Maximum length: 5000
`body.payment_intent_data.shipping.address.line1`	string	Required within parent	Maximum length: 5000
`body.payment_intent_data.shipping.address.line2`	string	Optional	Maximum length: 5000
`body.payment_intent_data.shipping.address.postal_code`	string	Optional	Maximum length: 5000
`body.payment_intent_data.shipping.address.state`	string	Optional	Maximum length: 5000
`body.payment_intent_data.shipping.carrier`	string	Optional	Maximum length: 5000
`body.payment_intent_data.shipping.name`	string	Required within parent	Maximum length: 5000
`body.payment_intent_data.shipping.phone`	string	Optional	Maximum length: 5000
`body.payment_intent_data.shipping.tracking_number`	string	Optional	Maximum length: 5000
`body.payment_intent_data.statement_descriptor`	string	Optional	Maximum length: 22
`body.payment_intent_data.statement_descriptor_suffix`	string	Optional	Maximum length: 22
`body.payment_intent_data.transfer_data`	object	Optional
`body.payment_intent_data.transfer_data.amount`	integer	Optional
`body.payment_intent_data.transfer_data.destination`	string	Required within parent
`body.payment_intent_data.transfer_group`	string	Optional
`body.payment_method_collection`	string	Optional	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). One of: always, if_required
`body.payment_method_configuration`	string	Optional	The ID of the payment method configuration to use with this Checkout session. Maximum length: 100
`body.payment_method_data`	object	Optional	This parameter allows you to set some attributes on the payment method created during a Checkout session.
`body.payment_method_data.allow_redisplay`	string	Optional	One of: always, limited, unspecified
`body.payment_method_options`	object	Optional	Payment-method-specific configuration.
`body.payment_method_options.acss_debit`	object	Optional
`body.payment_method_options.acss_debit.currency`	string	Optional	One of: cad, usd
`body.payment_method_options.acss_debit.mandate_options`	object	Optional
`body.payment_method_options.acss_debit.mandate_options.custom_mandate_url`	JSON	Optional
`body.payment_method_options.acss_debit.mandate_options.custom_mandate_url (anyOf 1)`	string	Alternative
`body.payment_method_options.acss_debit.mandate_options.custom_mandate_url (anyOf 2)`	string	Alternative	One of:
`body.payment_method_options.acss_debit.mandate_options.default_for`	array	Optional
`body.payment_method_options.acss_debit.mandate_options.default_for[]`	string	Each item	One of: invoice, subscription
`body.payment_method_options.acss_debit.mandate_options.interval_description`	string	Optional	Maximum length: 500
`body.payment_method_options.acss_debit.mandate_options.payment_schedule`	string	Optional	One of: combined, interval, sporadic
`body.payment_method_options.acss_debit.mandate_options.transaction_type`	string	Optional	One of: business, personal
`body.payment_method_options.acss_debit.setup_future_usage`	string	Optional	One of: none, off_session, on_session
`body.payment_method_options.acss_debit.target_date`	string	Optional	Maximum length: 5000
`body.payment_method_options.acss_debit.verification_method`	string	Optional	One of: automatic, instant, microdeposits
`body.payment_method_options.affirm`	object	Optional
`body.payment_method_options.affirm.capture_method`	string	Optional	One of: manual
`body.payment_method_options.affirm.setup_future_usage`	string	Optional	One of: none
`body.payment_method_options.afterpay_clearpay`	object	Optional
`body.payment_method_options.afterpay_clearpay.capture_method`	string	Optional	One of: manual
`body.payment_method_options.afterpay_clearpay.setup_future_usage`	string	Optional	One of: none
`body.payment_method_options.alipay`	object	Optional
`body.payment_method_options.alipay.setup_future_usage`	string	Optional	One of: none
`body.payment_method_options.alma`	object	Optional
`body.payment_method_options.alma.capture_method`	string	Optional	One of: manual
`body.payment_method_options.amazon_pay`	object	Optional
`body.payment_method_options.amazon_pay.capture_method`	string	Optional	One of: manual
`body.payment_method_options.amazon_pay.setup_future_usage`	string	Optional	One of: none, off_session
`body.payment_method_options.au_becs_debit`	object	Optional
`body.payment_method_options.au_becs_debit.setup_future_usage`	string	Optional	One of: none
`body.payment_method_options.au_becs_debit.target_date`	string	Optional	Maximum length: 5000
`body.payment_method_options.bacs_debit`	object	Optional
`body.payment_method_options.bacs_debit.mandate_options`	object	Optional
`body.payment_method_options.bacs_debit.mandate_options.reference_prefix`	JSON	Optional
`body.payment_method_options.bacs_debit.mandate_options.reference_prefix (anyOf 1)`	string	Alternative	Maximum length: 12
`body.payment_method_options.bacs_debit.mandate_options.reference_prefix (anyOf 2)`	string	Alternative	One of:
`body.payment_method_options.bacs_debit.setup_future_usage`	string	Optional	One of: none, off_session, on_session
`body.payment_method_options.bacs_debit.target_date`	string	Optional	Maximum length: 5000
`body.payment_method_options.bancontact`	object	Optional
`body.payment_method_options.bancontact.setup_future_usage`	string	Optional	One of: none, off_session
`body.payment_method_options.billie`	object	Optional
`body.payment_method_options.billie.capture_method`	string	Optional	One of: manual
`body.payment_method_options.blik`	object	Optional
`body.payment_method_options.blik.mandate_options`	object	Optional
`body.payment_method_options.blik.mandate_options.expires_at`	integer	Optional	Format: unix-time
`body.payment_method_options.blik.setup_future_usage`	string	Optional	One of: , none, off_session
`body.payment_method_options.boleto`	object	Optional
`body.payment_method_options.boleto.expires_after_days`	integer	Optional
`body.payment_method_options.boleto.setup_future_usage`	string	Optional	One of: none, off_session, on_session
`body.payment_method_options.card`	object	Optional
`body.payment_method_options.card.capture_method`	string	Optional	One of: manual
`body.payment_method_options.card.installments`	object	Optional
`body.payment_method_options.card.installments.enabled`	boolean	Optional
`body.payment_method_options.card.request_extended_authorization`	string	Optional	One of: if_available, never
`body.payment_method_options.card.request_incremental_authorization`	string	Optional	One of: if_available, never
`body.payment_method_options.card.request_multicapture`	string	Optional	One of: if_available, never
`body.payment_method_options.card.request_overcapture`	string	Optional	One of: if_available, never
`body.payment_method_options.card.request_three_d_secure`	string	Optional	One of: any, automatic, challenge
`body.payment_method_options.card.restrictions`	object	Optional
`body.payment_method_options.card.restrictions.brands_blocked`	array	Optional
`body.payment_method_options.card.restrictions.brands_blocked[]`	string	Each item	One of: american_express, discover_global_network, mastercard, visa
`body.payment_method_options.card.restrictions.funding_types_blocked`	array	Optional
`body.payment_method_options.card.restrictions.funding_types_blocked[]`	string	Each item	One of: credit, debit, prepaid
`body.payment_method_options.card.setup_future_usage`	string	Optional	One of: off_session, on_session
`body.payment_method_options.card.statement_descriptor_suffix_kana`	string	Optional	Maximum length: 22
`body.payment_method_options.card.statement_descriptor_suffix_kanji`	string	Optional	Maximum length: 17
`body.payment_method_options.cashapp`	object	Optional
`body.payment_method_options.cashapp.capture_method`	string	Optional	One of: manual
`body.payment_method_options.cashapp.setup_future_usage`	string	Optional	One of: none, off_session, on_session
`body.payment_method_options.crypto`	object	Optional
`body.payment_method_options.crypto.setup_future_usage`	string	Optional	One of: none
`body.payment_method_options.customer_balance`	Model	Optional	Expand Create a Checkout Session — request body — body payment method options customer balance
`body.payment_method_options.demo_pay`	object	Optional
`body.payment_method_options.demo_pay.setup_future_usage`	string	Optional	One of: none, off_session
`body.payment_method_options.eps`	object	Optional
`body.payment_method_options.eps.setup_future_usage`	string	Optional	One of: none
`body.payment_method_options.fpx`	object	Optional
`body.payment_method_options.fpx.setup_future_usage`	string	Optional	One of: none
`body.payment_method_options.giropay`	object	Optional
`body.payment_method_options.giropay.setup_future_usage`	string	Optional	One of: none
`body.payment_method_options.grabpay`	object	Optional
`body.payment_method_options.grabpay.setup_future_usage`	string	Optional	One of: none
`body.payment_method_options.ideal`	object	Optional
`body.payment_method_options.ideal.setup_future_usage`	string	Optional	One of: none
`body.payment_method_options.kakao_pay`	object	Optional
`body.payment_method_options.kakao_pay.capture_method`	string	Optional	One of: manual
`body.payment_method_options.kakao_pay.setup_future_usage`	string	Optional	One of: none, off_session
`body.payment_method_options.klarna`	object	Optional
`body.payment_method_options.klarna.capture_method`	string	Optional	One of: manual
`body.payment_method_options.klarna.setup_future_usage`	string	Optional	One of: none
`body.payment_method_options.klarna.subscriptions`	JSON	Optional
`body.payment_method_options.klarna.subscriptions (anyOf 1)`	array	Alternative
`body.payment_method_options.klarna.subscriptions (anyOf 1)[]`	object	Each item
`body.payment_method_options.klarna.subscriptions (anyOf 1)[].interval`	string	Required within parent	One of: day, month, week, year
`body.payment_method_options.klarna.subscriptions (anyOf 1)[].interval_count`	integer	Optional
`body.payment_method_options.klarna.subscriptions (anyOf 1)[].name`	string	Optional	Maximum length: 255
`body.payment_method_options.klarna.subscriptions (anyOf 1)[].next_billing`	object	Required within parent
`body.payment_method_options.klarna.subscriptions (anyOf 1)[].next_billing.amount`	integer	Required within parent
`body.payment_method_options.klarna.subscriptions (anyOf 1)[].next_billing.date`	string	Required within parent	Maximum length: 5000
`body.payment_method_options.klarna.subscriptions (anyOf 1)[].reference`	string	Required within parent	Maximum length: 255
`body.payment_method_options.klarna.subscriptions (anyOf 2)`	string	Alternative	One of:
`body.payment_method_options.konbini`	object	Optional
`body.payment_method_options.konbini.expires_after_days`	integer	Optional
`body.payment_method_options.konbini.setup_future_usage`	string	Optional	One of: none
`body.payment_method_options.kr_card`	object	Optional
`body.payment_method_options.kr_card.capture_method`	string	Optional	One of: manual
`body.payment_method_options.kr_card.setup_future_usage`	string	Optional	One of: none, off_session
`body.payment_method_options.link`	object	Optional
`body.payment_method_options.link.capture_method`	string	Optional	One of: manual
`body.payment_method_options.link.setup_future_usage`	string	Optional	One of: none, off_session
`body.payment_method_options.mobilepay`	object	Optional
`body.payment_method_options.mobilepay.capture_method`	string	Optional	One of: manual
`body.payment_method_options.mobilepay.setup_future_usage`	string	Optional	One of: none
`body.payment_method_options.multibanco`	object	Optional
`body.payment_method_options.multibanco.setup_future_usage`	string	Optional	One of: none
`body.payment_method_options.naver_pay`	object	Optional
`body.payment_method_options.naver_pay.capture_method`	string	Optional	One of: manual
`body.payment_method_options.naver_pay.setup_future_usage`	string	Optional	One of: none, off_session
`body.payment_method_options.oxxo`	object	Optional
`body.payment_method_options.oxxo.expires_after_days`	integer	Optional
`body.payment_method_options.oxxo.setup_future_usage`	string	Optional	One of: none
`body.payment_method_options.p24`	object	Optional
`body.payment_method_options.p24.setup_future_usage`	string	Optional	One of: none
`body.payment_method_options.p24.tos_shown_and_accepted`	boolean	Optional
`body.payment_method_options.pay_by_bank`	object	Optional
`body.payment_method_options.payco`	object	Optional
`body.payment_method_options.payco.capture_method`	string	Optional	One of: manual
`body.payment_method_options.payco.setup_future_usage`	string	Optional	One of: none
`body.payment_method_options.paynow`	object	Optional
`body.payment_method_options.paynow.setup_future_usage`	string	Optional	One of: none
`body.payment_method_options.paypal`	Model	Optional	Expand Create a Checkout Session — request body — body payment method options paypal
`body.payment_method_options.payto`	object	Optional
`body.payment_method_options.payto.mandate_options`	Model	Optional	Expand Create a Setup Intent — request body — body payment method options payto mandate options
`body.payment_method_options.payto.setup_future_usage`	string	Optional	One of: none, off_session
`body.payment_method_options.pix`	object	Optional
`body.payment_method_options.pix.amount_includes_iof`	string	Optional	One of: always, never
`body.payment_method_options.pix.expires_after_seconds`	integer	Optional
`body.payment_method_options.pix.mandate_options`	Model	Optional	Expand Create a Setup Intent — request body — body payment method options pix mandate options
`body.payment_method_options.pix.setup_future_usage`	string	Optional	One of: none, off_session
`body.payment_method_options.revolut_pay`	object	Optional
`body.payment_method_options.revolut_pay.capture_method`	string	Optional	One of: manual
`body.payment_method_options.revolut_pay.setup_future_usage`	string	Optional	One of: none, off_session
`body.payment_method_options.samsung_pay`	object	Optional
`body.payment_method_options.samsung_pay.capture_method`	string	Optional	One of: manual
`body.payment_method_options.samsung_pay.setup_future_usage`	string	Optional	One of: none
`body.payment_method_options.satispay`	object	Optional
`body.payment_method_options.satispay.capture_method`	string	Optional	One of: manual
`body.payment_method_options.scalapay`	object	Optional
`body.payment_method_options.scalapay.capture_method`	string	Optional	One of: manual
`body.payment_method_options.sepa_debit`	object	Optional
`body.payment_method_options.sepa_debit.mandate_options`	object	Optional
`body.payment_method_options.sepa_debit.mandate_options.reference_prefix`	JSON	Optional
`body.payment_method_options.sepa_debit.mandate_options.reference_prefix (anyOf 1)`	string	Alternative	Maximum length: 12
`body.payment_method_options.sepa_debit.mandate_options.reference_prefix (anyOf 2)`	string	Alternative	One of:
`body.payment_method_options.sepa_debit.setup_future_usage`	string	Optional	One of: none, off_session, on_session
`body.payment_method_options.sepa_debit.target_date`	string	Optional	Maximum length: 5000
`body.payment_method_options.sequra`	object	Optional
`body.payment_method_options.sequra.capture_method`	string	Optional	One of: manual
`body.payment_method_options.sofort`	object	Optional
`body.payment_method_options.sofort.setup_future_usage`	string	Optional	One of: none
`body.payment_method_options.sunbit`	object	Optional
`body.payment_method_options.sunbit.capture_method`	string	Optional	One of: manual
`body.payment_method_options.sunbit.setup_future_usage`	string	Optional	One of: none
`body.payment_method_options.swish`	object	Optional
`body.payment_method_options.swish.reference`	string	Optional	Maximum length: 5000
`body.payment_method_options.twint`	object	Optional
`body.payment_method_options.twint.setup_future_usage`	string	Optional	One of: none, off_session
`body.payment_method_options.upi`	object	Optional
`body.payment_method_options.upi.mandate_options`	object	Optional
`body.payment_method_options.upi.mandate_options.amount`	integer	Optional
`body.payment_method_options.upi.mandate_options.amount_type`	string	Optional	One of: fixed, maximum
`body.payment_method_options.upi.mandate_options.description`	string	Optional	Maximum length: 20
`body.payment_method_options.upi.mandate_options.end_date`	integer	Optional	Format: unix-time
`body.payment_method_options.upi.setup_future_usage`	string	Optional	One of: , none, off_session, on_session
`body.payment_method_options.us_bank_account`	object	Optional
`body.payment_method_options.us_bank_account.financial_connections`	object	Optional
`body.payment_method_options.us_bank_account.financial_connections.permissions`	array	Optional
`body.payment_method_options.us_bank_account.financial_connections.permissions[]`	string	Each item	One of: balances, ownership, payment_method, transactions Maximum length: 5000
`body.payment_method_options.us_bank_account.financial_connections.prefetch`	array	Optional
`body.payment_method_options.us_bank_account.financial_connections.prefetch[]`	string	Each item	One of: balances, ownership, transactions
`body.payment_method_options.us_bank_account.setup_future_usage`	string	Optional	One of: none, off_session, on_session
`body.payment_method_options.us_bank_account.target_date`	string	Optional	Maximum length: 5000
`body.payment_method_options.us_bank_account.verification_method`	string	Optional	One of: automatic, instant
`body.payment_method_options.wechat_pay`	object	Optional
`body.payment_method_options.wechat_pay.app_id`	string	Optional	Maximum length: 5000
`body.payment_method_options.wechat_pay.client`	string	Required within parent	One of: android, ios, web
`body.payment_method_options.wechat_pay.setup_future_usage`	string	Optional	One of: none
`body.permissions`	object	Optional	This property is used to set up permissions for various actions (for example, update) on the CheckoutSession object. Can only be set when creating `embedded_page` or `elements` sessions. For specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`.
`body.permissions.update_shipping_details`	string	Optional	One of: client_only, server_only
`body.phone_number_collection`	object	Optional	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).
`body.phone_number_collection.enabled`	boolean	Required within parent
`body.redirect_on_completion`	string	Optional	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`. One of: always, if_required, never
`body.return_url`	string	Optional	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.
`body.saved_payment_method_options`	object	Optional	Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
`body.saved_payment_method_options.allow_redisplay_filters`	array	Optional
`body.saved_payment_method_options.allow_redisplay_filters[]`	string	Each item	One of: always, limited, unspecified
`body.saved_payment_method_options.payment_method_remove`	string	Optional	One of: disabled, enabled
`body.saved_payment_method_options.payment_method_save`	string	Optional	One of: disabled, enabled
`body.setup_intent_data`	object	Optional	A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.
`body.setup_intent_data.description`	string	Optional	Maximum length: 1000
`body.setup_intent_data.metadata`	object	Optional	Additional keys: see wildcard field
`body.setup_intent_data.metadata.*`	string	Additional keys
`body.setup_intent_data.on_behalf_of`	string	Optional
`body.shipping_address_collection`	object	Optional	When set, provides configuration for Checkout to collect a shipping address from a customer.
`body.shipping_address_collection.allowed_countries`	array	Required within parent
`body.shipping_address_collection.allowed_countries[]`	string	Each item	One of: AC, AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CV, CW, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MK, ML, MM, MN, MO, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW, ZZ
`body.shipping_options`	array	Optional	The shipping rate options to apply to this Session. Up to a maximum of 5.
`body.shipping_options[]`	Model	Each item	Expand Create a Checkout Session — request body — body shipping options item
`body.submit_type`	string	Optional	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`. One of: auto, book, donate, pay, subscribe
`body.subscription_data`	object	Optional	A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
`body.subscription_data.application_fee_percent`	number	Optional
`body.subscription_data.billing_cycle_anchor`	integer	Optional	Format: unix-time
`body.subscription_data.billing_cycle_anchor_config`	object	Optional
`body.subscription_data.billing_cycle_anchor_config.day_of_month`	integer	Required within parent
`body.subscription_data.billing_cycle_anchor_config.hour`	integer	Optional
`body.subscription_data.billing_cycle_anchor_config.minute`	integer	Optional
`body.subscription_data.billing_cycle_anchor_config.month`	integer	Optional
`body.subscription_data.billing_cycle_anchor_config.second`	integer	Optional
`body.subscription_data.billing_mode`	object	Optional
`body.subscription_data.billing_mode.flexible`	object	Optional
`body.subscription_data.billing_mode.flexible.proration_discounts`	string	Optional	One of: included, itemized
`body.subscription_data.billing_mode.type`	string	Required within parent	One of: classic, flexible
`body.subscription_data.default_tax_rates`	array	Optional
`body.subscription_data.default_tax_rates[]`	string	Each item	Maximum length: 5000
`body.subscription_data.description`	string	Optional	Maximum length: 500
`body.subscription_data.invoice_settings`	object	Optional
`body.subscription_data.invoice_settings.issuer`	object	Optional
`body.subscription_data.invoice_settings.issuer.account`	string	Optional
`body.subscription_data.invoice_settings.issuer.type`	string	Required within parent	One of: account, self
`body.subscription_data.metadata`	object	Optional	Additional keys: see wildcard field
`body.subscription_data.metadata.*`	string	Additional keys
`body.subscription_data.on_behalf_of`	string	Optional
`body.subscription_data.pending_invoice_item_interval`	object	Optional
`body.subscription_data.pending_invoice_item_interval.interval`	string	Required within parent	One of: day, month, week, year
`body.subscription_data.pending_invoice_item_interval.interval_count`	integer	Optional
`body.subscription_data.proration_behavior`	string	Optional	One of: create_prorations, none
`body.subscription_data.transfer_data`	object	Optional
`body.subscription_data.transfer_data.amount_percent`	number	Optional
`body.subscription_data.transfer_data.destination`	string	Required within parent
`body.subscription_data.trial_end`	integer	Optional	Format: unix-time
`body.subscription_data.trial_period_days`	integer	Optional
`body.subscription_data.trial_settings`	object	Optional
`body.subscription_data.trial_settings.end_behavior`	object	Required within parent
`body.subscription_data.trial_settings.end_behavior.missing_payment_method`	string	Required within parent	One of: cancel, create_invoice, pause
`body.success_url`	string	Optional	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).
`body.tax_id_collection`	object	Optional	Controls tax ID collection during checkout.
`body.tax_id_collection.enabled`	boolean	Required within parent
`body.tax_id_collection.required`	string	Optional	One of: if_supported, never
`body.ui_mode`	string	Optional	The UI mode of the Session. Defaults to `hosted_page`. One of: elements, embedded_page, form, hosted_page
`body.wallet_options`	object	Optional	Wallet-specific configuration.
`body.wallet_options.link`	object	Optional
`body.wallet_options.link.display`	string	Optional	One of: auto, never

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Create a Checkout Session — response body

Referenced models: Create a Checkout Session — response body

Schemas

799 more schemas are linked from the tables above, on the schema pages.

Create a payment link — request body — body custom fields item

Field	Type	Presence	Description and constraints
`$`	object	Root
`dropdown`	object	Optional
`dropdown.default_value`	string	Optional	Maximum length: 100
`dropdown.options`	array	Required within parent
`dropdown.options[]`	object	Each item
`dropdown.options[].label`	string	Required within parent	Maximum length: 100
`dropdown.options[].value`	string	Required within parent	Maximum length: 100
`key`	string	Required within parent	Maximum length: 200
`label`	object	Required within parent
`label.custom`	string	Required within parent	Maximum length: 100
`label.type`	string	Required within parent	One of: custom
`numeric`	object	Optional
`numeric.default_value`	string	Optional	Maximum length: 255
`numeric.maximum_length`	integer	Optional
`numeric.minimum_length`	integer	Optional
`optional`	boolean	Optional
`text`	object	Optional
`text.default_value`	string	Optional	Maximum length: 255
`text.maximum_length`	integer	Optional
`text.minimum_length`	integer	Optional
`type`	string	Required within parent	One of: dropdown, numeric, text

Create a payment link — request body — body custom text

Field	Type	Presence	Description and constraints
`$`	object	Root	Display additional text for your customers using custom text. You can't set this parameter if `ui_mode` is `elements`.
`after_submit`	JSON	Optional
`after_submit (anyOf 1)`	object	Alternative
`after_submit (anyOf 1).message`	string	Required within parent	Maximum length: 1200
`after_submit (anyOf 2)`	string	Alternative	One of:
`shipping_address`	JSON	Optional
`shipping_address (anyOf 1)`	object	Alternative
`shipping_address (anyOf 1).message`	string	Required within parent	Maximum length: 1200
`shipping_address (anyOf 2)`	string	Alternative	One of:
`submit`	JSON	Optional
`submit (anyOf 1)`	object	Alternative
`submit (anyOf 1).message`	string	Required within parent	Maximum length: 1200
`submit (anyOf 2)`	string	Alternative	One of:
`terms_of_service_acceptance`	JSON	Optional
`terms_of_service_acceptance (anyOf 1)`	object	Alternative
`terms_of_service_acceptance (anyOf 1).message`	string	Required within parent	Maximum length: 1200
`terms_of_service_acceptance (anyOf 2)`	string	Alternative	One of:

Create a Checkout Session — request body — body payment method options customer balance

Field	Type	Presence	Description and constraints
`$`	object	Root
`bank_transfer`	object	Optional
`bank_transfer.eu_bank_transfer`	object	Optional
`bank_transfer.eu_bank_transfer.country`	string	Required within parent	Maximum length: 5000
`bank_transfer.requested_address_types`	array	Optional
`bank_transfer.requested_address_types[]`	string	Each item	One of: aba, iban, sepa, sort_code, spei, swift, zengin
`bank_transfer.type`	string	Required within parent	One of: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, us_bank_transfer
`funding_type`	string	Optional	One of: bank_transfer
`setup_future_usage`	string	Optional	One of: none

Create a Setup Intent — request body — body payment method options pix mandate options

Field	Type	Presence	Description and constraints
`$`	object	Root
`amount`	integer	Optional
`amount_includes_iof`	string	Optional	One of: always, never
`amount_type`	string	Optional	One of: fixed, maximum
`currency`	string	Optional	Format: currency
`end_date`	string	Optional	Maximum length: 5000
`payment_schedule`	string	Optional	One of: halfyearly, monthly, quarterly, weekly, yearly
`reference`	string	Optional	Maximum length: 35
`start_date`	string	Optional	Maximum length: 5000

Create a Setup Intent — request body — body payment method options payto mandate options

Field	Type	Presence	Description and constraints
`$`	object	Root
`amount`	JSON	Optional
`amount (anyOf 1)`	integer	Alternative
`amount (anyOf 2)`	string	Alternative	One of:
`amount_type`	string	Optional	One of: , fixed, maximum
`end_date`	JSON	Optional
`end_date (anyOf 1)`	string	Alternative	Maximum length: 5000
`end_date (anyOf 2)`	string	Alternative	One of:
`payment_schedule`	string	Optional	One of: , adhoc, annual, daily, fortnightly, monthly, quarterly, semi_annual, weekly
`payments_per_period`	JSON	Optional
`payments_per_period (anyOf 1)`	integer	Alternative
`payments_per_period (anyOf 2)`	string	Alternative	One of:
`purpose`	string	Optional	One of: , dependant_support, government, loan, mortgage, other, pension, personal, retail, salary, tax, utility
`start_date`	JSON	Optional
`start_date (anyOf 1)`	string	Alternative	Maximum length: 5000
`start_date (anyOf 2)`	string	Alternative	One of:

Create a Checkout Session — request body — body payment method options paypal

Field	Type	Presence	Description and constraints
`$`	object	Root
`capture_method`	string	Optional	One of: , manual
`preferred_locale`	string	Optional	One of: cs-CZ, da-DK, de-AT, de-DE, de-LU, el-GR, en-GB, en-US, es-ES, fi-FI, fr-BE, fr-FR, fr-LU, hu-HU, it-IT, nl-BE, nl-NL, pl-PL, pt-PT, sk-SK, sv-SE
`reference`	string	Optional	Maximum length: 127
`risk_correlation_id`	string	Optional	Maximum length: 32
`setup_future_usage`	string	Optional	One of: , none, off_session

Create a payment link — request body — body line items item price data

Field	Type	Presence	Description and constraints
`$`	object	Root
`currency`	string	Required within parent	Format: currency
`product`	string	Optional	Maximum length: 5000
`product_data`	Model	Optional	Expand Update an invoice's line item — request body — body price data product data
`recurring`	object	Optional
`recurring.interval`	string	Required within parent	One of: day, month, week, year
`recurring.interval_count`	integer	Optional
`tax_behavior`	string	Optional	One of: exclusive, inclusive, unspecified
`unit_amount`	integer	Optional
`unit_amount_decimal`	string	Optional	Format: decimal

Referenced models: Update an invoice's line item — request body — body price data product data

Create a Checkout Session — request body — body shipping options item

Field	Type	Presence	Description and constraints
`$`	object	Root
`shipping_rate`	string	Optional	Maximum length: 5000
`shipping_rate_data`	Model	Optional	Expand Create an invoice — request body — body shipping cost shipping rate data

Referenced models: Create an invoice — request body — body shipping cost shipping rate data

Create a Checkout Session — response body — wallet options value link

Field	Type	Presence	Description and constraints
`$`	object	Root
`link`	Model	Optional	Expand Create a Checkout Session — response body — wallet options value link link

Referenced models: Create a Checkout Session — response body — wallet options value link link

Delete a customer — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`deleted`	boolean	Required within parent	Always true for a deleted object Known values: True
`id`	string	Required within parent	Unique identifier for the object. Maximum length: 5000
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: customer

Cancel a refund — response body — presentment details

Field	Type	Presence	Description and constraints
`$`	object	Root
`presentment_amount`	JSON	Required within parent
`presentment_amount (anyOf 1)`	integer	Alternative	Amount intended to be collected by this payment, denominated in `presentment_currency`.
`presentment_amount (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`presentment_currency`	string	Required within parent	Currency presented to the customer during payment. Maximum length: 5000

Policy, approvals and errors

SDK function policy ID: stripe.postcheckoutsessions. Catalog operation: PostCheckoutSessions. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source

Report an issue with this page