puffin-app/docs/stripe-checkout-sessions.md

Checkout Sessions

A Checkout Session represents your customer’s session as they pay for one-time purchases or subscriptions through Checkout or Payment Links. We recommend creating a new Session each time your customer attempts to pay.

Once payment is successful, the Checkout Session will contain a reference to the Customer, and either the successful PaymentIntent or an active Subscription.

You can create a Checkout Session on your server and redirect to its URL to begin Checkout.

Related guide: Checkout quickstart

Endpoints

Create a Checkout Session

• POST /v1/checkout/sessions

Update a Checkout Session

• POST /v1/checkout/sessions/:id

Retrieve a Checkout Session

• GET /v1/checkout/sessions/:id

Retrieve a Checkout Session's line items

• GET /v1/checkout/sessions/:id/line_items

List all Checkout Sessions

• GET /v1/checkout/sessions

Expire a Checkout Session

• POST /v1/checkout/sessions/:id/expire

The Checkout Session object

Attributes

• id (string) Unique identifier for the object.

• object (string) String representing the object’s type. Objects of the same type share the same value.

• adaptive_pricing (object, nullable) Settings for price localization with Adaptive Pricing.

  • adaptive_pricing.enabled (boolean) If enabled, Adaptive Pricing is available on eligible sessions.

• after_expiration (object, nullable) When set, provides configuration for actions to take if this Checkout Session expires.

  • after_expiration.recovery (object, nullable) When set, configuration used to recover the Checkout Session on expiry.

    • after_expiration.recovery.allow_promotion_codes (boolean) Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to false

    • after_expiration.recovery.enabled (boolean) If true, a recovery url will be generated to recover this Checkout Session if it expires before a transaction is completed. It will be attached to the Checkout Session object upon expiration.

    • after_expiration.recovery.expires_at (timestamp, nullable) The timestamp at which the recovery URL will expire.

    • after_expiration.recovery.url (string, nullable) URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session

• allow_promotion_codes (boolean, nullable) Enables user redeemable promotion codes.

• amount_subtotal (integer, nullable) Total of all items before discounts or taxes are applied.

• amount_total (integer, nullable) Total of all items after discounts and taxes are applied.

• automatic_tax (object) Details on the state of automatic tax for the session, including the status of the latest tax calculation.

  • automatic_tax.enabled (boolean) Indicates whether automatic tax is enabled for the session

  • automatic_tax.liability (object, nullable) The account that’s liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.

    • automatic_tax.liability.account (string, nullable) The connected account being referenced when type is account.

    • automatic_tax.liability.type (enum) Type of the account referenced. Possible enum values:

      • account Indicates that the account being referenced is a connected account which is different from the account making the API request but related to it.

      • self Indicates that the account being referenced is the account making the API request.

  • automatic_tax.provider (string, nullable) The tax provider powering automatic tax.

  • automatic_tax.status (enum, nullable) The status of the most recent automated tax calculation for this session. Possible enum values:

    • complete The automatic tax calculation was successful.

    • failed The tax calculation failed, please try again later.

    • requires_location_inputs The location details supplied on the customer aren’t valid or don’t provide enough location information to accurately determine tax rates for the customer.

• billing_address_collection (enum, nullable) Describes whether Checkout should collect the customer’s billing address. Defaults to auto. Possible enum values:

  • auto Checkout will only collect the billing address when necessary. When using automatic_tax, Checkout will collect the minimum number of fields required for tax calculation.

  • required Checkout will always collect the customer’s billing address.

• branding_settings (object, nullable) Details on the state of branding settings for the session.

  • branding_settings.background_color (string) A hex color value starting with # representing the background color for the Checkout Session.

  • branding_settings.border_style (enum) The border style for the Checkout Session. Must be one of rounded, rectangular, or pill. Possible enum values:

    • pill
    • rectangular
    • rounded

  • branding_settings.button_color (string) A hex color value starting with # representing the button color for the Checkout Session.

  • branding_settings.display_name (string) The display name shown on the Checkout Session.

  • branding_settings.font_family (string) The font family for the Checkout Session. Must be one of the supported font families.

  • branding_settings.icon (object, nullable) The icon for the Checkout Session. You cannot set both logo and icon.

    • branding_settings.icon.file (string, nullable) The ID of a File upload representing the icon. Purpose must be business_icon. Required if type is file and disallowed otherwise.

    • branding_settings.icon.type (enum) The type of image for the icon. Must be one of file or url. Possible enum values:

      • file
      • url

    • branding_settings.icon.url (string, nullable) The URL of the image. Present when type is url.

  • branding_settings.logo (object, nullable) The logo for the Checkout Session. You cannot set both logo and icon.

    • branding_settings.logo.file (string, nullable) The ID of a File upload representing the logo. Purpose must be business_logo. Required if type is file and disallowed otherwise.

    • branding_settings.logo.type (enum) The type of image for the logo. Must be one of file or url. Possible enum values:

      • file
      • url

    • branding_settings.logo.url (string, nullable) The URL of the image. Present when type is url.

• cancel_url (string, nullable) 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_id (string, nullable) 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_secret (string, nullable) The client secret of your Checkout Session. Applies to Checkout Sessions with ui_mode: embedded or ui_mode: custom. For ui_mode: embedded, the client secret is to be used when initializing Stripe.js embedded checkout. For ui_mode: custom, use the client secret with initCheckout on your front end.

• collected_information (object, nullable) Information about the customer collected within the Checkout Session.

  • collected_information.business_name (string, nullable) Customer’s business name for this Checkout Session

  • collected_information.individual_name (string, nullable) Customer’s individual name for this Checkout Session

  • collected_information.shipping_details (object, nullable) Shipping information for this Checkout Session.

    • collected_information.shipping_details.address (object) Customer address.

      • collected_information.shipping_details.address.city (string, nullable) City, district, suburb, town, or village.

      • collected_information.shipping_details.address.country (string, nullable) Two-letter country code (ISO 3166-1 alpha-2).

      • collected_information.shipping_details.address.line1 (string, nullable) Address line 1, such as the street, PO Box, or company name.

      • collected_information.shipping_details.address.line2 (string, nullable) Address line 2, such as the apartment, suite, unit, or building.

      • collected_information.shipping_details.address.postal_code (string, nullable) ZIP or postal code.

      • collected_information.shipping_details.address.state (string, nullable) State, county, province, or region.

    • collected_information.shipping_details.name (string) Customer name.

• consent (object, nullable) Results of consent_collection for this session.

  • consent.promotions (enum, nullable) If opt_in, the customer consents to receiving promotional communications from the merchant about this Checkout Session. Possible enum values:

    • opt_in
    • opt_out

  • consent.terms_of_service (enum, nullable) If accepted, the customer in this Checkout Session has agreed to the merchant’s terms of service. Possible enum values:

    • accepted The customer has accepted the specified terms of service agreement.

• consent_collection (object, nullable) When set, provides configuration for the Checkout Session to gather active consent from customers.

  • consent_collection.payment_method_reuse_agreement (object, nullable) If set to hidden, it will hide legal text related to the reuse of a payment method.

    • consent_collection.payment_method_reuse_agreement.position (enum) Determines the position and visibility of the payment method reuse agreement in the UI. When set to auto, Stripe’s defaults will be used.

      When set to hidden, the payment method reuse agreement text will always be hidden in the UI. Possible enum values:

      • auto
      • hidden

  • consent_collection.promotions (enum, nullable) If set to auto, enables the collection of customer consent for promotional communications. The Checkout Session will determine whether to display an option to opt into promotional communication from the merchant depending on the customer’s locale. Only available to US merchants. Possible enum values:

    • auto
    • none

  • consent_collection.terms_of_service (enum, nullable) If set to required, it requires customers to accept the terms of service before being able to pay. Possible enum values:

    • none
    • required

• created (timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.

• currency (enum, nullable) Three-letter ISO currency code, in lowercase. Must be a supported currency.

• currency_conversion (object, nullable) Currency conversion details for Adaptive Pricing sessions created before 2025-03-31.

  • currency_conversion.amount_subtotal (integer) Total of all items in source currency before discounts or taxes are applied.

  • currency_conversion.amount_total (integer) Total of all items in source currency after discounts and taxes are applied.

  • currency_conversion.fx_rate (decimal string) Exchange rate used to convert source currency amounts to customer currency amounts

  • currency_conversion.source_currency (string) Creation currency of the CheckoutSession before localization

• custom_fields (array of objects) Collect additional information from your customer using custom fields. Up to 3 fields are supported.

  • custom_fields.dropdown (object, nullable) Configuration for type=dropdown fields.

    • custom_fields.dropdown.default_value (string, nullable) The value that will pre-fill on the payment page.

    • custom_fields.dropdown.options (array of objects) The options available for the customer to select. Up to 200 options allowed.

      • custom_fields.dropdown.options.label (string) The label for the option, displayed to the customer. Up to 100 characters.

      • custom_fields.dropdown.options.value (string) The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.

    • custom_fields.dropdown.value (string, nullable) The option selected by the customer. This will be the value for the option.

  • custom_fields.key (string) String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.

  • custom_fields.label (object) The label for the field, displayed to the customer.

    • custom_fields.label.custom (string, nullable) Custom text for the label, displayed to the customer. Up to 50 characters.

    • custom_fields.label.type (enum) The type of the label. Possible enum values:

      • custom Set a custom label for the field.

  • custom_fields.numeric (object, nullable) Configuration for type=numeric fields.

    • custom_fields.numeric.default_value (string, nullable) The value that will pre-fill the field on the payment page.

    • custom_fields.numeric.maximum_length (integer, nullable) The maximum character length constraint for the customer’s input.

    • custom_fields.numeric.minimum_length (integer, nullable) The minimum character length requirement for the customer’s input.

    • custom_fields.numeric.value (string, nullable) The value entered by the customer, containing only digits.

  • custom_fields.optional (boolean) Whether the customer is required to complete the field before completing the Checkout Session. Defaults to false.

  • custom_fields.text (object, nullable) Configuration for type=text fields.

    • custom_fields.text.default_value (string, nullable) The value that will pre-fill the field on the payment page.

    • custom_fields.text.maximum_length (integer, nullable) The maximum character length constraint for the customer’s input.

    • custom_fields.text.minimum_length (integer, nullable) The minimum character length requirement for the customer’s input.

    • custom_fields.text.value (string, nullable) The value entered by the customer.

  • custom_fields.type (enum) The type of the field. Possible enum values:

    • dropdown Provide a list of options for your customer to select.

    • numeric Collect a numbers-only field from your customer.

    • text Collect a string field from your customer.

• custom_text (object) Display additional text for your customers using custom text.

  • custom_text.after_submit (object, nullable) Custom text that should be displayed after the payment confirmation button.

    • custom_text.after_submit.message (string) Text may be up to 1200 characters in length.

  • custom_text.shipping_address (object, nullable) Custom text that should be displayed alongside shipping address collection.

    • custom_text.shipping_address.message (string) Text may be up to 1200 characters in length.

  • custom_text.submit (object, nullable) Custom text that should be displayed alongside the payment confirmation button.

    • custom_text.submit.message (string) Text may be up to 1200 characters in length.

  • custom_text.terms_of_service_acceptance (object, nullable) Custom text that should be displayed in place of the default terms of service agreement text.

    • custom_text.terms_of_service_acceptance.message (string) Text may be up to 1200 characters in length.

• customer (string, nullable) 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_creation (enum, nullable) Configure whether a Checkout Session creates a Customer when the Checkout Session completes. Possible enum values:

  • always The Checkout Session will always create a Customer when a Session confirmation is attempted.

  • if_required The Checkout Session will only create a Customer if it is required for Session confirmation. Currently, only subscription mode Sessions and payment mode Sessions with post-purchase invoices enabled require a Customer.

• customer_details (object, nullable) 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_details.address (object, nullable) The customer’s address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.

    • customer_details.address.city (string, nullable) City, district, suburb, town, or village.

    • customer_details.address.country (string, nullable) Two-letter country code (ISO 3166-1 alpha-2).

    • customer_details.address.line1 (string, nullable) Address line 1, such as the street, PO Box, or company name.

    • customer_details.address.line2 (string, nullable) Address line 2, such as the apartment, suite, unit, or building.

    • customer_details.address.postal_code (string, nullable) ZIP or postal code.

    • customer_details.address.state (string, nullable) State, county, province, or region.

  • customer_details.business_name (string, nullable) The customer’s business name after a completed Checkout Session.

  • customer_details.email (string, nullable) The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry. Otherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form.

  • customer_details.individual_name (string, nullable) The customer’s individual name after a completed Checkout Session.

  • customer_details.name (string, nullable) The customer’s name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.

  • customer_details.phone (string, nullable) The customer’s phone number after a completed Checkout Session.

  • customer_details.tax_exempt (enum, nullable) The customer’s tax exempt status after a completed Checkout Session. Possible enum values:

    • exempt
    • none
    • reverse

  • customer_details.tax_ids (array of objects, nullable) The customer’s tax IDs after a completed Checkout Session.

    • customer_details.tax_ids.type (enum) The type of the tax ID, one of ad_nrt, ar_cuit, eu_vat, bo_tin, br_cnpj, br_cpf, cn_tin, co_nit, cr_tin, do_rcn, ec_ruc, eu_oss_vat, hr_oib, pe_ruc, ro_tin, rs_pib, sv_nit, uy_ruc, ve_rif, vn_tin, gb_vat, nz_gst, au_abn, au_arn, in_gst, no_vat, no_voec, za_vat, ch_vat, mx_rfc, sg_uen, ru_inn, ru_kpp, ca_bn, hk_br, es_cif, tw_vat, th_vat, jp_cn, jp_rn, jp_trn, li_uid, li_vat, my_itn, us_ein, kr_brn, ca_qst, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, my_sst, sg_gst, ae_trn, cl_tin, sa_vat, id_npwp, my_frp, il_vat, ge_vat, ua_vat, is_vat, bg_uic, hu_tin, si_tin, ke_pin, tr_tin, eg_tin, ph_tin, al_tin, bh_vat, kz_bin, ng_tin, om_vat, de_stn, ch_uid, tz_vat, uz_vat, uz_tin, md_vat, ma_vat, by_tin, ao_tin, bs_tin, bb_tin, cd_nif, mr_nif, me_pib, zw_tin, ba_tin, gn_nif, mk_vat, sr_fin, sn_ninea, am_tin, np_pan, tj_tin, ug_tin, zm_tin, kh_tin, aw_tin, az_tin, bd_bin, bj_ifu, et_tin, kg_tin, la_tin, cm_niu, cv_nif, bf_ifu, or unknown Possible enum values:

      • ad_nrt
      • ae_trn
      • al_tin
      • am_tin
      • ao_tin
      • ar_cuit
      • au_abn
      • au_arn
      • aw_tin
      • az_tin
      • ba_tin
      • bb_tin
      • bd_bin
      • bf_ifu
      • bg_uic
      • bh_vat
      • bj_ifu
      • bo_tin
      • br_cnpj
      • br_cpf
      • bs_tin
      • by_tin
      • ca_bn
      • ca_gst_hst
      • ca_pst_bc
      • ca_pst_mb
      • ca_pst_sk
      • ca_qst
      • cd_nif
      • ch_uid
      • ch_vat
      • cl_tin
      • cm_niu
      • cn_tin
      • co_nit
      • cr_tin
      • cv_nif
      • de_stn
      • do_rcn
      • ec_ruc
      • eg_tin
      • es_cif
      • et_tin
      • eu_oss_vat
      • eu_vat
      • gb_vat
      • ge_vat
      • gn_nif
      • hk_br
      • hr_oib
      • hu_tin
      • id_npwp
      • il_vat
      • in_gst
      • is_vat
      • jp_cn
      • jp_rn
      • jp_trn
      • ke_pin
      • kg_tin
      • kh_tin
      • kr_brn
      • kz_bin
      • la_tin
      • li_uid
      • li_vat
      • ma_vat
      • md_vat
      • me_pib
      • mk_vat
      • mr_nif
      • mx_rfc
      • my_frp
      • my_itn
      • my_sst
      • ng_tin
      • no_vat
      • no_voec
      • np_pan
      • nz_gst
      • om_vat
      • pe_ruc
      • ph_tin
      • ro_tin
      • rs_pib
      • ru_inn
      • ru_kpp
      • sa_vat
      • sg_gst
      • sg_uen
      • si_tin
      • sn_ninea
      • sr_fin
      • sv_nit
      • th_vat
      • tj_tin
      • tr_tin
      • tw_vat
      • tz_vat
      • ua_vat
      • ug_tin
      • unknown
      • us_ein
      • uy_ruc
      • uz_tin
      • uz_vat
      • ve_rif
      • vn_tin
      • za_vat
      • zm_tin
      • zw_tin

    • customer_details.tax_ids.value (string, nullable) The value of the tax ID.

• customer_email (string, nullable) 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.

• discounts (array of objects, nullable) List of coupons and promotion codes attached to the Checkout Session.

  • discounts.coupon (string, nullable) Coupon attached to the Checkout Session.

  • discounts.promotion_code (string, nullable) Promotion code attached to the Checkout Session.

• excluded_payment_method_types (array of strings, nullable) 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.

• expires_at (timestamp) The timestamp at which the Checkout Session will expire.

• invoice (string, nullable) ID of the invoice created by the Checkout Session, if it exists.

• invoice_creation (object, nullable) Details on the state of invoice creation for the Checkout Session.

  • invoice_creation.enabled (boolean) Indicates whether invoice creation is enabled for the Checkout Session.

  • invoice_creation.invoice_data (object) Parameters passed when creating invoices for payment-mode Checkout Sessions.

    • invoice_creation.invoice_data.account_tax_ids (array of strings, nullable) The account tax IDs associated with the invoice.

    • invoice_creation.invoice_data.custom_fields (array of objects, nullable) Custom fields displayed on the invoice.

      • invoice_creation.invoice_data.custom_fields.name (string) The name of the custom field.

      • invoice_creation.invoice_data.custom_fields.value (string) The value of the custom field.

    • invoice_creation.invoice_data.description (string, nullable) An arbitrary string attached to the object. Often useful for displaying to users.

    • invoice_creation.invoice_data.footer (string, nullable) Footer displayed on the invoice.

    • invoice_creation.invoice_data.issuer (object, nullable) The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.

      • invoice_creation.invoice_data.issuer.account (string, nullable) The connected account being referenced when type is account.

      • invoice_creation.invoice_data.issuer.type (enum) Type of the account referenced. Possible enum values:

        • account Indicates that the account being referenced is a connected account which is different from the account making the API request but related to it.

        • self Indicates that the account being referenced is the account making the API request.

    • invoice_creation.invoice_data.metadata (object, nullable) Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    • invoice_creation.invoice_data.rendering_options (object, nullable) Options for invoice PDF rendering.

      • invoice_creation.invoice_data.rendering_options.amount_tax_display (string, nullable) How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.

      • invoice_creation.invoice_data.rendering_options.template (string, nullable) ID of the invoice rendering template to be used for the generated invoice.

• line_items (object, nullable) The line items purchased by the customer.

  • line_items.object (string) String representing the object’s type. Objects of the same type share the same value. Always has the value list.

  • line_items.data (array of objects) Details about each object.

    • line_items.data.id (string) Unique identifier for the object.

    • line_items.data.object (string) String representing the object’s type. Objects of the same type share the same value.

    • line_items.data.amount_discount (integer) Total discount amount applied. If no discounts were applied, defaults to 0.

    • line_items.data.amount_subtotal (integer) Total before any discounts or taxes are applied.

    • line_items.data.amount_tax (integer) Total tax amount applied. If no tax was applied, defaults to 0.

    • line_items.data.amount_total (integer) Total after discounts and taxes.

    • line_items.data.currency (enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • line_items.data.description (string, nullable) An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.

    • line_items.data.discounts (array of objects, nullable) The discounts applied to the line item.

      • line_items.data.discounts.amount (integer) The amount discounted.

      • line_items.data.discounts.discount (object) The discount applied.

        • line_items.data.discounts.discount.id (string) The ID of the discount object. Discounts cannot be fetched by ID. Use expand[]=discounts in API calls to expand discount IDs in an array.

        • line_items.data.discounts.discount.object (string) String representing the object’s type. Objects of the same type share the same value.

        • line_items.data.discounts.discount.checkout_session (string, nullable) The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.

        • line_items.data.discounts.discount.customer (string, nullable) The ID of the customer associated with this discount.

        • line_items.data.discounts.discount.end (timestamp, nullable) If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null.

        • line_items.data.discounts.discount.invoice (string, nullable) The invoice that the discount’s coupon was applied to, if it was applied directly to a particular invoice.

        • line_items.data.discounts.discount.invoice_item (string, nullable) The invoice item id (or invoice line item id for invoice line items of type=‘subscription’) that the discount’s coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.

        • line_items.data.discounts.discount.promotion_code (string, nullable) The promotion code applied to create this discount.

        • line_items.data.discounts.discount.source (object) The source of the discount.

          • line_items.data.discounts.discount.source.coupon (string, nullable) The coupon that was redeemed to create this discount.

          • line_items.data.discounts.discount.source.type (enum) The source type of the discount. Possible enum values:

            • coupon Coupon source type

        • line_items.data.discounts.discount.start (timestamp) Date that the coupon was applied.

        • line_items.data.discounts.discount.subscription (string, nullable) The subscription that this coupon is applied to, if it is applied to a particular subscription.

        • line_items.data.discounts.discount.subscription_item (string, nullable) The subscription item that this coupon is applied to, if it is applied to a particular subscription item.

    • line_items.data.price (object, nullable) The price used to generate the line item.

      • line_items.data.price.id (string) Unique identifier for the object.

      • line_items.data.price.object (string) String representing the object’s type. Objects of the same type share the same value.

      • line_items.data.price.active (boolean) Whether the price can be used for new purchases.

      • line_items.data.price.billing_scheme (enum) Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes. Possible enum values:

        • per_unit
        • tiered

      • line_items.data.price.created (timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.

      • line_items.data.price.currency (enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.

      • line_items.data.price.currency_options (object, nullable) Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.

        • line_items.data.price.currency_options.<currency>.custom_unit_amount (object, nullable) When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.

          • line_items.data.price.currency_options.<currency>.custom_unit_amount.maximum (integer, nullable) The maximum unit amount the customer can specify for this item.

          • line_items.data.price.currency_options.<currency>.custom_unit_amount.minimum (integer, nullable) The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.

          • line_items.data.price.currency_options.<currency>.custom_unit_amount.preset (integer, nullable) The starting unit amount which can be updated by the customer.

        • line_items.data.price.currency_options.<currency>.tax_behavior (enum, nullable) Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed. Possible enum values:

          • exclusive
          • inclusive
          • unspecified

        • line_items.data.price.currency_options.<currency>.tiers (array of objects, nullable) Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.

          • line_items.data.price.currency_options.<currency>.tiers.flat_amount (integer, nullable) Price for the entire tier.

          • line_items.data.price.currency_options.<currency>.tiers.flat_amount_decimal (decimal string, nullable) Same as flat_amount, but contains a decimal value with at most 12 decimal places.

          • line_items.data.price.currency_options.<currency>.tiers.unit_amount (integer, nullable) Per unit price for units relevant to the tier.

          • line_items.data.price.currency_options.<currency>.tiers.unit_amount_decimal (decimal string, nullable) Same as unit_amount, but contains a decimal value with at most 12 decimal places.

          • line_items.data.price.currency_options.<currency>.tiers.up_to (integer, nullable) Up to and including to this quantity will be contained in the tier.

        • line_items.data.price.currency_options.<currency>.unit_amount (integer, nullable) The unit amount in cents to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.

        • line_items.data.price.currency_options.<currency>.unit_amount_decimal (decimal string, nullable) The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.

      • line_items.data.price.custom_unit_amount (object, nullable) When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.

        • line_items.data.price.custom_unit_amount.maximum (integer, nullable) The maximum unit amount the customer can specify for this item.

        • line_items.data.price.custom_unit_amount.minimum (integer, nullable) The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.

        • line_items.data.price.custom_unit_amount.preset (integer, nullable) The starting unit amount which can be updated by the customer.

      • line_items.data.price.livemode (boolean) Has the value true if the object exists in live mode or the value false if the object exists in test mode.

      • line_items.data.price.lookup_key (string, nullable) A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.

      • line_items.data.price.metadata (object) Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

      • line_items.data.price.nickname (string, nullable) A brief description of the price, hidden from customers.

      • line_items.data.price.product (string) The ID of the product this price is associated with.

      • line_items.data.price.recurring (object, nullable) The recurring components of a price such as interval and usage_type.

        • line_items.data.price.recurring.interval (enum) The frequency at which a subscription is billed. One of day, week, month or year.

        • line_items.data.price.recurring.interval_count (integer) The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.

        • line_items.data.price.recurring.meter (string, nullable) The meter tracking the usage of a metered price

        • line_items.data.price.recurring.usage_type (enum) Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed.

      • line_items.data.price.tax_behavior (enum, nullable) Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed. Possible enum values:

        • exclusive
        • inclusive
        • unspecified

      • line_items.data.price.tiers (array of objects, nullable) Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.

        • line_items.data.price.tiers.flat_amount (integer, nullable) Price for the entire tier.

        • line_items.data.price.tiers.flat_amount_decimal (decimal string, nullable) Same as flat_amount, but contains a decimal value with at most 12 decimal places.

        • line_items.data.price.tiers.unit_amount (integer, nullable) Per unit price for units relevant to the tier.

        • line_items.data.price.tiers.unit_amount_decimal (decimal string, nullable) Same as unit_amount, but contains a decimal value with at most 12 decimal places.

        • line_items.data.price.tiers.up_to (integer, nullable) Up to and including to this quantity will be contained in the tier.

      • line_items.data.price.tiers_mode (enum, nullable) Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows. Possible enum values:

        • graduated
        • volume

      • line_items.data.price.transform_quantity (object, nullable) Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.

        • line_items.data.price.transform_quantity.divide_by (integer) Divide usage by this number.

        • line_items.data.price.transform_quantity.round (enum) After division, either round the result up or down.

      • line_items.data.price.type (enum) One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. Possible enum values:

        • one_time
        • recurring

      • line_items.data.price.unit_amount (integer, nullable) The unit amount in cents to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.

      • line_items.data.price.unit_amount_decimal (decimal string, nullable) The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.

    • line_items.data.quantity (integer, nullable) The quantity of products being purchased.

    • line_items.data.taxes (array of objects, nullable) The taxes applied to the line item.

      • line_items.data.taxes.amount (integer) Amount of tax applied for this rate.

      • line_items.data.taxes.rate (object) The tax rate applied.

        • line_items.data.taxes.rate.id (string) Unique identifier for the object.

        • line_items.data.taxes.rate.object (string) String representing the object’s type. Objects of the same type share the same value.

        • line_items.data.taxes.rate.active (boolean) Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.

        • line_items.data.taxes.rate.country (string, nullable) Two-letter country code (ISO 3166-1 alpha-2).

        • line_items.data.taxes.rate.created (timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.

        • line_items.data.taxes.rate.description (string, nullable) An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.

        • line_items.data.taxes.rate.display_name (string) The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.

        • line_items.data.taxes.rate.effective_percentage (float, nullable) Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product’s taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.

        • line_items.data.taxes.rate.flat_amount (object, nullable) The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.

          • line_items.data.taxes.rate.flat_amount.amount (integer) Amount of the tax when the rate_type is flat_amount. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

          • line_items.data.taxes.rate.flat_amount.currency (string) Three-letter ISO currency code, in lowercase.

        • line_items.data.taxes.rate.inclusive (boolean) This specifies if the tax rate is inclusive or exclusive.

        • line_items.data.taxes.rate.jurisdiction (string, nullable) The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.

        • line_items.data.taxes.rate.jurisdiction_level (enum, nullable) The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates. Possible enum values:

          • city
          • country
          • county
          • district
          • multiple
          • state

        • line_items.data.taxes.rate.livemode (boolean) Has the value true if the object exists in live mode or the value false if the object exists in test mode.

        • line_items.data.taxes.rate.metadata (object, nullable) Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

        • line_items.data.taxes.rate.percentage (float) Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.

        • line_items.data.taxes.rate.rate_type (enum, nullable) Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. Possible enum values:

          • flat_amount A fixed amount applied as tax, regardless of the taxable amount, such as a retail delivery fee.

          • percentage A tax rate expressed as a percentage of the taxable amount, such as the sales tax rate in California.

        • line_items.data.taxes.rate.state (string, nullable) ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.

        • line_items.data.taxes.rate.tax_type (enum, nullable) The high-level tax type, such as vat or sales_tax. Possible enum values:

          • amusement_tax Amusement Tax

          • communications_tax Communications Tax

          • gst Goods and Services Tax

          • hst Harmonized Sales Tax

          • igst Integrated Goods and Services Tax

          • jct Japanese Consumption Tax

          • lease_tax Chicago Lease Tax

          • pst Provincial Sales Tax

          • qst Quebec Sales Tax

          • retail_delivery_fee Retail Delivery Fee

          • rst Retail Sales Tax

          • sales_tax Sales Tax

          • service_tax Service Tax

          • vat Value-Added Tax

      • line_items.data.taxes.taxability_reason (enum, nullable) The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. Possible enum values:

        • customer_exempt No tax is applied as the customer is exempt from tax.

        • not_collecting No tax is collected either because you are not registered to collect tax in this jurisdiction, or because the non-taxable product tax code (txcd_00000000) was used.

        • not_subject_to_tax No tax is imposed on this transaction.

        • not_supported No tax applied. Stripe doesn’t support this jurisdiction, territory, or product.

        • portion_product_exempt A portion of the price is exempt from tax.

        • portion_reduced_rated A portion of the price is taxed at a reduced rate.

        • portion_standard_rated A portion of the price is taxed at the standard rate.

        • product_exempt The product or service is nontaxable or exempt from tax.

        • product_exempt_holiday The product or service is not taxed due to a sales tax holiday.

        • proportionally_rated The shipping cost tax rate is calculated as a weighted average of the other line items’ rates, weighted by their amounts.

        • reduced_rated Taxed at a reduced rate.

        • reverse_charge No tax is applied as it is the responsibility of the buyer to account for tax in this case.

        • standard_rated Taxed at the standard rate.

        • taxable_basis_reduced A reduced amount of the price is subject to tax.

        • zero_rated The transaction is taxed at a special rate of 0% or the transaction is exempt (but these exempt transactions still let you deduct the “input VAT” paid on your business purchases).

      • line_items.data.taxes.taxable_amount (integer, nullable) The amount on which tax is calculated, in cents.

  • line_items.has_more (boolean) True if this list has another page of items after this one that can be fetched.

  • line_items.url (string) The URL where this list can be accessed.

• livemode (boolean) Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• locale (enum, nullable) The IETF language tag of the locale Checkout is displayed in. If blank or auto, the browser’s locale is used. Possible enum values:

  • 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

• metadata (object, nullable) Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

• mode (enum) The mode of the Checkout Session. Possible enum values:

  • payment Accept one-time payments for cards, iDEAL, and more.

  • setup Save payment details to charge your customers later.

  • subscription Use Stripe Billing to set up fixed-price subscriptions.

• name_collection (object, nullable) Details on the state of name collection for the session.

  • name_collection.business (object, nullable) The settings applied for collecting a business’s name.

    • name_collection.business.enabled (boolean) Indicates whether business name collection is enabled for the session

    • name_collection.business.optional (boolean) Whether the customer is required to complete the field before completing the Checkout Session. Defaults to false.

  • name_collection.individual (object, nullable) The settings applied for collecting an individual’s name.

    • name_collection.individual.enabled (boolean) Indicates whether individual name collection is enabled for the session

    • name_collection.individual.optional (boolean) Whether the customer is required to complete the field before completing the Checkout Session. Defaults to false.

• optional_items (array of objects, nullable) The optional items presented to the customer at checkout.

• origin_context (enum, nullable) Where the user is coming from. This informs the optimizations that are applied to the session. Possible enum values:

  • mobile_app The Checkout Session originates from a mobile app.

  • web The Checkout Session originates from a web page.

• payment_intent (string, nullable) 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 instead.

• payment_link (string, nullable) The ID of the Payment Link that created this Session.

• payment_method_collection (enum, nullable) Configure whether a Checkout Session should collect a payment method. Defaults to always. Possible enum values:

  • always The Checkout Session will always collect a PaymentMethod.

  • if_required The Checkout Session will only collect a PaymentMethod if there is an amount due.

• payment_method_configuration_details (object, nullable) Information about the payment method configuration used for this Checkout session if using dynamic payment methods.

  • payment_method_configuration_details.id (string) ID of the payment method configuration used.

  • payment_method_configuration_details.parent (string, nullable) ID of the parent payment method configuration used.

• payment_method_options (object, nullable) Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.

  • payment_method_options.acss_debit (object, nullable) If the Checkout Session’s payment_method_types includes acss_debit, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.acss_debit.currency (enum, nullable) Currency supported by the bank account. Returned when the Session is in setup mode. Possible enum values:

      • cad Canadian dollars

      • usd US dollars

    • payment_method_options.acss_debit.mandate_options (object, nullable) Additional fields for Mandate creation

      • payment_method_options.acss_debit.mandate_options.custom_mandate_url (string, nullable) A URL for custom mandate text

      • payment_method_options.acss_debit.mandate_options.default_for (array of enums, nullable) List of Stripe products where this mandate can be selected automatically. Returned when the Session is in setup mode. Possible enum values:

        • invoice Enables payments for Stripe Invoices. ‘subscription’ must also be provided.

        • subscription Enables payments for Stripe Subscriptions. ‘invoice’ must also be provided.

      • payment_method_options.acss_debit.mandate_options.interval_description (string, nullable) Description of the interval. Only required if the ‘payment_schedule’ parameter is ‘interval’ or ‘combined’.

      • payment_method_options.acss_debit.mandate_options.payment_schedule (enum, nullable) Payment schedule for the mandate. Possible enum values:

        • combined Payments can be initiated at a pre-defined interval or sporadically

        • interval Payments are initiated at a regular pre-defined interval

        • sporadic Payments are initiated sporadically

      • payment_method_options.acss_debit.mandate_options.transaction_type (enum, nullable) Transaction type of the mandate. Possible enum values:

        • business Transactions are made for business reasons

        • personal Transactions are made for personal reasons

    • payment_method_options.acss_debit.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

      • on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

    • payment_method_options.acss_debit.target_date (string, nullable) Controls when Stripe will attempt to debit the funds from the customer’s account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.

    • payment_method_options.acss_debit.verification_method (enum, nullable) Bank account verification method. Possible enum values:

      • automatic Instant verification with fallback to microdeposits.

      • instant Instant verification.

      • microdeposits Verification using microdeposits.

  • payment_method_options.affirm (object, nullable) If the Checkout Session’s payment_method_types includes affirm, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.affirm.capture_method (enum, nullable) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.affirm.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.afterpay_clearpay (object, nullable) If the Checkout Session’s payment_method_types includes afterpay_clearpay, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.afterpay_clearpay.capture_method (enum, nullable) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.afterpay_clearpay.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.alipay (object, nullable) If the Checkout Session’s payment_method_types includes alipay, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.alipay.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.alma (object, nullable) If the Checkout Session’s payment_method_types includes alma, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.alma.capture_method (enum, nullable) Controls when the funds will be captured from the customer’s account. Possible enum values:
      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

  • payment_method_options.amazon_pay (object, nullable) If the Checkout Session’s payment_method_types includes amazon_pay, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.amazon_pay.capture_method (enum, nullable) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.amazon_pay.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.au_becs_debit (object, nullable) If the Checkout Session’s payment_method_types includes au_becs_debit, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.au_becs_debit.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

    • payment_method_options.au_becs_debit.target_date (string, nullable) Controls when Stripe will attempt to debit the funds from the customer’s account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.

  • payment_method_options.bacs_debit (object, nullable) If the Checkout Session’s payment_method_types includes bacs_debit, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.bacs_debit.mandate_options (object, nullable) Additional fields for Mandate creation

      • payment_method_options.bacs_debit.mandate_options.reference_prefix (string, nullable) Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: ‘/’, ‘_’, ‘-’, ‘&’, ‘.’. Cannot begin with ‘DDIC’ or ‘STRIPE’.

    • payment_method_options.bacs_debit.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

      • on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

    • payment_method_options.bacs_debit.target_date (string, nullable) Controls when Stripe will attempt to debit the funds from the customer’s account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.

  • payment_method_options.bancontact (object, nullable) If the Checkout Session’s payment_method_types includes bancontact, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.bancontact.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.billie (object, nullable) If the Checkout Session’s payment_method_types includes billie, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.billie.capture_method (enum, nullable) Controls when the funds will be captured from the customer’s account. Possible enum values:
      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

  • payment_method_options.boleto (object, nullable) If the Checkout Session’s payment_method_types includes boleto, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.boleto.expires_after_days (integer) The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.

    • payment_method_options.boleto.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

      • on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

  • payment_method_options.card (object, nullable) If the Checkout Session’s payment_method_types includes card, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.card.capture_method (enum, nullable) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.card.installments (object, nullable) Additional fields for Installments configuration

      • payment_method_options.card.installments.enabled (boolean, nullable) Indicates if installments are enabled

    • payment_method_options.card.request_extended_authorization (enum, nullable) Request ability to capture beyond the standard authorization validity window for this CheckoutSession. Possible enum values:

      • if_available Use if_available if you want to extend the capture window when eligible for extended authorization.

      • never Use never if you don’t want to extend the capture window.

    • payment_method_options.card.request_incremental_authorization (enum, nullable) Request ability to increment the authorization for this CheckoutSession. Possible enum values:

      • if_available Use if_available if you want to increment the authorization on the PaymentIntent when eligible.

      • never Use never if you don’t want to increment the authorization on the PaymentIntent.

    • payment_method_options.card.request_multicapture (enum, nullable) Request ability to make multiple captures for this CheckoutSession. Possible enum values:

      • if_available Use if_available if you want to use multicapture when eligible.

      • never Use never if you don’t want to use multicapture.

    • payment_method_options.card.request_overcapture (enum, nullable) Request ability to overcapture for this CheckoutSession. Possible enum values:

      • if_available Use if_available if you want to overcapture the payment when eligible.

      • never Use never if you don’t want to overcapture the payment.

    • payment_method_options.card.request_three_d_secure (enum) We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to automatic. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine. Possible enum values:

      • any Use any to manually request 3DS with a preference for a frictionless flow, increasing the likelihood of the authentication being completed without any additional input from the customer. 3DS will always be attempted if it is supported for the card, but Stripe can’t guarantee your preference because the issuer determines the ultimate authentication flow. To learn more about 3DS flows, read our guide.

      • automatic (Default) Our SCA Engine automatically prompts your customers for authentication based on risk level and other requirements.

      • challenge Use challenge to request 3DS with a preference for a challenge flow, where the customer must respond to a prompt for active authentication. Stripe can’t guarantee your preference because the issuer determines the ultimate authentication flow. To learn more about 3DS flows, read our guide.

    • payment_method_options.card.restrictions (object, nullable) Restrictions to apply to the card payment method. For example, you can block specific card brands.

      • payment_method_options.card.restrictions.brands_blocked (array of enums, nullable) Specify the card brands to block in the Checkout Session. If a customer enters or selects a card belonging to a blocked brand, they can’t complete the Session. Possible enum values:
        • american_express
        • discover_global_network
        • mastercard
        • visa

    • payment_method_options.card.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

      • on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

    • payment_method_options.card.statement_descriptor_suffix_kana (string, nullable) Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the concatenation of both prefix and suffix (including separators) will appear truncated to 22 characters.

    • payment_method_options.card.statement_descriptor_suffix_kanji (string, nullable) Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the concatenation of both prefix and suffix (including separators) will appear truncated to 17 characters.

  • payment_method_options.cashapp (object, nullable) If the Checkout Session’s payment_method_types includes cashapp, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.cashapp.capture_method (enum, nullable) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.cashapp.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.customer_balance (object, nullable) If the Checkout Session’s payment_method_types includes customer_balance, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.customer_balance.bank_transfer (object, nullable) Configuration for the bank transfer funding type, if the funding_type is set to bank_transfer.

      • payment_method_options.customer_balance.bank_transfer.eu_bank_transfer (object, nullable) Configuration for eu_bank_transfer

        • payment_method_options.customer_balance.bank_transfer.eu_bank_transfer.country (enum) The desired country code of the bank account information. Permitted values include: BE, DE, ES, FR, IE, or NL. Possible enum values:
          • BE
          • DE
          • ES
          • FR
          • IE
          • NL

      • payment_method_options.customer_balance.bank_transfer.requested_address_types (array of enums, nullable) List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.

        Permitted values include: sort_code, zengin, iban, or spei. Possible enum values:

        • aba aba bank account address type

        • iban iban bank account address type

        • sepa sepa bank account address type

        • sort_code sort_code bank account address type

        • spei spei bank account address type

        • swift swift bank account address type

        • zengin zengin bank account address type

      • payment_method_options.customer_balance.bank_transfer.type (enum, nullable) The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer. Possible enum values:

        • eu_bank_transfer A bank transfer of type eu_bank_transfer

        • gb_bank_transfer A bank transfer of type gb_bank_transfer

        • jp_bank_transfer A bank transfer of type jp_bank_transfer

        • mx_bank_transfer A bank transfer of type mx_bank_transfer

        • us_bank_transfer A bank transfer of type us_bank_transfer

    • payment_method_options.customer_balance.funding_type (enum, nullable) The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer. Possible enum values:

      • bank_transfer

    • payment_method_options.customer_balance.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.eps (object, nullable) If the Checkout Session’s payment_method_types includes eps, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.eps.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.fpx (object, nullable) If the Checkout Session’s payment_method_types includes fpx, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.fpx.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.giropay (object, nullable) If the Checkout Session’s payment_method_types includes giropay, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.giropay.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.grabpay (object, nullable) If the Checkout Session’s payment_method_types includes grabpay, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.grabpay.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.ideal (object, nullable) If the Checkout Session’s payment_method_types includes ideal, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.ideal.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.kakao_pay (object, nullable) If the Checkout Session’s payment_method_types includes kakao_pay, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.kakao_pay.capture_method (enum, nullable) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.kakao_pay.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.klarna (object, nullable) If the Checkout Session’s payment_method_types includes klarna, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.klarna.capture_method (enum, nullable) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.klarna.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

      • on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

  • payment_method_options.konbini (object, nullable) If the Checkout Session’s payment_method_types includes konbini, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.konbini.expires_after_days (integer, nullable) The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and expires_after_days set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.

    • payment_method_options.konbini.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.kr_card (object, nullable) If the Checkout Session’s payment_method_types includes kr_card, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.kr_card.capture_method (enum, nullable) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.kr_card.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.link (object, nullable) If the Checkout Session’s payment_method_types includes link, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.link.capture_method (enum, nullable) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.link.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.mobilepay (object, nullable) If the Checkout Session’s payment_method_types includes mobilepay, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.mobilepay.capture_method (enum, nullable) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.mobilepay.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.multibanco (object, nullable) If the Checkout Session’s payment_method_types includes multibanco, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.multibanco.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.naver_pay (object, nullable) If the Checkout Session’s payment_method_types includes naver_pay, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.naver_pay.capture_method (enum, nullable) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.naver_pay.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.oxxo (object, nullable) If the Checkout Session’s payment_method_types includes oxxo, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.oxxo.expires_after_days (integer) The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.

    • payment_method_options.oxxo.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.p24 (object, nullable) If the Checkout Session’s payment_method_types includes p24, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.p24.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.payco (object, nullable) If the Checkout Session’s payment_method_types includes payco, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.payco.capture_method (enum, nullable) Controls when the funds will be captured from the customer’s account. Possible enum values:
      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

  • payment_method_options.paynow (object, nullable) If the Checkout Session’s payment_method_types includes paynow, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.paynow.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.paypal (object, nullable) If the Checkout Session’s payment_method_types includes paypal, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.paypal.capture_method (enum, nullable) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.paypal.preferred_locale (string, nullable) Preferred locale of the PayPal checkout page that the customer is redirected to.

    • payment_method_options.paypal.reference (string, nullable) A reference of the PayPal transaction visible to customer which is mapped to PayPal’s invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.

    • payment_method_options.paypal.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.pix (object, nullable) If the Checkout Session’s payment_method_types includes pix, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.pix.amount_includes_iof (enum, nullable) Determines if the amount includes the IOF tax. Possible enum values:

      • always The IOF tax is included in the amount.

      • never The IOF tax is not included in the amount.

    • payment_method_options.pix.expires_after_seconds (integer, nullable) The number of seconds after which Pix payment will expire.

    • payment_method_options.pix.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.revolut_pay (object, nullable) If the Checkout Session’s payment_method_types includes revolut_pay, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.revolut_pay.capture_method (enum, nullable) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.revolut_pay.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.samsung_pay (object, nullable) If the Checkout Session’s payment_method_types includes samsung_pay, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.samsung_pay.capture_method (enum, nullable) Controls when the funds will be captured from the customer’s account. Possible enum values:
      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

  • payment_method_options.satispay (object, nullable) If the Checkout Session’s payment_method_types includes satispay, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.satispay.capture_method (enum, nullable) Controls when the funds will be captured from the customer’s account. Possible enum values:
      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

  • payment_method_options.sepa_debit (object, nullable) If the Checkout Session’s payment_method_types includes sepa_debit, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.sepa_debit.mandate_options (object, nullable) Additional fields for Mandate creation

      • payment_method_options.sepa_debit.mandate_options.reference_prefix (string, nullable) Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: ‘/’, ‘_’, ‘-’, ‘&’, ‘.’. Cannot begin with ‘STRIPE’.

    • payment_method_options.sepa_debit.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

      • on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

    • payment_method_options.sepa_debit.target_date (string, nullable) Controls when Stripe will attempt to debit the funds from the customer’s account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.

  • payment_method_options.sofort (object, nullable) If the Checkout Session’s payment_method_types includes sofort, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.sofort.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.swish (object, nullable) If the Checkout Session’s payment_method_types includes swish, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.swish.reference (string, nullable) The order reference that will be displayed to customers in the Swish application. Defaults to the id of the Payment Intent.

  • payment_method_options.twint (object, nullable) If the Checkout Session’s payment_method_types includes twint, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.twint.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.us_bank_account (object, nullable) If the Checkout Session’s payment_method_types includes us_bank_account, this hash contains the configurations that will be applied to each payment attempt of that type.

    • payment_method_options.us_bank_account.financial_connections (object, nullable) Additional fields for Financial Connections Session creation

      • payment_method_options.us_bank_account.financial_connections.filters (object, nullable) Filter the list of accounts that are allowed to be linked.

        • payment_method_options.us_bank_account.financial_connections.filters.account_subcategories (array of enums, nullable) The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings. Possible enum values:

          • checking Bank account subcategory is checking

          • savings Bank account subcategory is savings

      • payment_method_options.us_bank_account.financial_connections.permissions (array of enums, nullable) The list of permissions to request. The payment_method permission must be included. Possible enum values:

        • balances Allows accessing balance data from the account.

        • ownership Allows accessing ownership data from the account.

        • payment_method Allows the creation of a payment method from the account.

        • transactions Allows accessing transactions data from the account.

      • payment_method_options.us_bank_account.financial_connections.prefetch (array of enums, nullable) Data features requested to be retrieved upon account creation. Possible enum values:

        • balances Requests to prefetch balance data on accounts collected in this session.

        • ownership Requests to prefetch ownership data on accounts collected in this session.

        • transactions Requests to prefetch transaction data on accounts collected in this session.

      • payment_method_options.us_bank_account.financial_connections.return_url (string, nullable) For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.

    • payment_method_options.us_bank_account.setup_future_usage (enum, nullable) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

      • on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

    • payment_method_options.us_bank_account.target_date (string, nullable) Controls when Stripe will attempt to debit the funds from the customer’s account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.

    • payment_method_options.us_bank_account.verification_method (enum, nullable) Bank account verification method. Possible enum values:

      • automatic Instant verification with fallback to microdeposits.

      • instant Instant verification only.

• payment_method_types (array of strings) A list of the types of payment methods (e.g. card) this Checkout Session is allowed to accept.

• payment_status (enum) 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. Possible enum values:

  • no_payment_required The payment is delayed to a future date, or the Checkout Session is in setup mode and doesn’t require a payment at this time.

  • paid The payment funds are available in your account.

  • unpaid The payment funds are not yet available in your account.

• permissions (object, nullable) 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.

  • permissions.update_shipping_details (enum, nullable) Determines which entity is allowed to update the shipping details.

    Default is client_only. Stripe Checkout client will automatically update the shipping details. If set to server_only, only your server is allowed to update the shipping details.

    When set to server_only, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API. Possible enum values:

    • client_only
    • server_only

• phone_number_collection (object, nullable) Details on the state of phone number collection for the session.

  • phone_number_collection.enabled (boolean) Indicates whether phone number collection is enabled for the session

• presentment_details (object, nullable) A hash containing information about the currency presentation to the customer, including the displayed currency and amount used for conversion from the integration currency.

  • presentment_details.presentment_amount (integer) Amount intended to be collected by this payment, denominated in presentment_currency.

  • presentment_details.presentment_currency (string) Currency presented to the customer during payment.

• recovered_from (string, nullable) The ID of the original expired Checkout Session that triggered the recovery flow.

• redirect_on_completion (enum, nullable) This parameter applies to ui_mode: embedded. Learn more about the redirect behavior of embedded sessions. Defaults to always. Possible enum values:

  • always The Session will always redirect to the return_url after successful confirmation.

  • if_required The Session will only redirect to the return_url after a redirect-based payment method is used.

  • never The Session will never redirect to the return_url, and redirect-based payment methods will be disabled.

• return_url (string, nullable) Applies to Checkout Sessions with ui_mode: embedded or ui_mode: custom. 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_options (object, nullable) Controls saved payment method settings for the session. Only available in payment and subscription mode.

  • saved_payment_method_options.allow_redisplay_filters (array of enums, nullable) Uses the allow_redisplay value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout. Possible enum values:

    • always When set, Checkout will show eligible saved payment methods with the allow_redisplay value of always

    • limited When set, Checkout will show eligible saved payment methods with the allow_redisplay value of limited

    • unspecified When set, Checkout will show eligible saved payment methods with the allow_redisplay value of unspecified

  • saved_payment_method_options.payment_method_remove (enum, nullable) Enable customers to choose if they wish to remove their saved payment methods. Disabled by default. Possible enum values:

    • disabled Removing payment methods will be disabled for this Checkout Session. This is the default option.

    • enabled Removing payment methods will be enabled for this Checkout Session.

  • saved_payment_method_options.payment_method_save (enum, nullable) Enable customers to choose if they wish to save their payment method for future use. Disabled by default. Possible enum values:

    • disabled Saving payment methods will be disabled for this Checkout Session. This is the default option.

    • enabled Saving payment methods will be enabled for this Checkout Session.

• setup_intent (string, nullable) 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 instead.

• shipping_address_collection (object, nullable) When set, provides configuration for Checkout to collect a shipping address from a customer.

  • shipping_address_collection.allowed_countries (array of enums) An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SY, UM, VI. Possible enum values:
    • 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

• shipping_cost (object, nullable) The details of the customer cost of shipping, including the customer chosen ShippingRate.

  • shipping_cost.amount_subtotal (integer) Total shipping cost before any discounts or taxes are applied.

  • shipping_cost.amount_tax (integer) Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.

  • shipping_cost.amount_total (integer) Total shipping cost after discounts and taxes are applied.

  • shipping_cost.shipping_rate (string, nullable) The ID of the ShippingRate for this order.

  • shipping_cost.taxes (array of objects, nullable) The taxes applied to the shipping rate.

    • shipping_cost.taxes.amount (integer) Amount of tax applied for this rate.

    • shipping_cost.taxes.rate (object) The tax rate applied.

      • shipping_cost.taxes.rate.id (string) Unique identifier for the object.

      • shipping_cost.taxes.rate.object (string) String representing the object’s type. Objects of the same type share the same value.

      • shipping_cost.taxes.rate.active (boolean) Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.

      • shipping_cost.taxes.rate.country (string, nullable) Two-letter country code (ISO 3166-1 alpha-2).

      • shipping_cost.taxes.rate.created (timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.

      • shipping_cost.taxes.rate.description (string, nullable) An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.

      • shipping_cost.taxes.rate.display_name (string) The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.

      • shipping_cost.taxes.rate.effective_percentage (float, nullable) Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product’s taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.

      • shipping_cost.taxes.rate.flat_amount (object, nullable) The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.

        • shipping_cost.taxes.rate.flat_amount.amount (integer) Amount of the tax when the rate_type is flat_amount. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

        • shipping_cost.taxes.rate.flat_amount.currency (string) Three-letter ISO currency code, in lowercase.

      • shipping_cost.taxes.rate.inclusive (boolean) This specifies if the tax rate is inclusive or exclusive.

      • shipping_cost.taxes.rate.jurisdiction (string, nullable) The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.

      • shipping_cost.taxes.rate.jurisdiction_level (enum, nullable) The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates. Possible enum values:

        • city
        • country
        • county
        • district
        • multiple
        • state

      • shipping_cost.taxes.rate.livemode (boolean) Has the value true if the object exists in live mode or the value false if the object exists in test mode.

      • shipping_cost.taxes.rate.metadata (object, nullable) Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

      • shipping_cost.taxes.rate.percentage (float) Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.

      • shipping_cost.taxes.rate.rate_type (enum, nullable) Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. Possible enum values:

        • flat_amount A fixed amount applied as tax, regardless of the taxable amount, such as a retail delivery fee.

        • percentage A tax rate expressed as a percentage of the taxable amount, such as the sales tax rate in California.

      • shipping_cost.taxes.rate.state (string, nullable) ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.

      • shipping_cost.taxes.rate.tax_type (enum, nullable) The high-level tax type, such as vat or sales_tax. Possible enum values:

        • amusement_tax Amusement Tax

        • communications_tax Communications Tax

        • gst Goods and Services Tax

        • hst Harmonized Sales Tax

        • igst Integrated Goods and Services Tax

        • jct Japanese Consumption Tax

        • lease_tax Chicago Lease Tax

        • pst Provincial Sales Tax

        • qst Quebec Sales Tax

        • retail_delivery_fee Retail Delivery Fee

        • rst Retail Sales Tax

        • sales_tax Sales Tax

        • service_tax Service Tax

        • vat Value-Added Tax

    • shipping_cost.taxes.taxability_reason (enum, nullable) The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. Possible enum values:

      • customer_exempt No tax is applied as the customer is exempt from tax.

      • not_collecting No tax is collected either because you are not registered to collect tax in this jurisdiction, or because the non-taxable product tax code (txcd_00000000) was used.

      • not_subject_to_tax No tax is imposed on this transaction.

      • not_supported No tax applied. Stripe doesn’t support this jurisdiction, territory, or product.

      • portion_product_exempt A portion of the price is exempt from tax.

      • portion_reduced_rated A portion of the price is taxed at a reduced rate.

      • portion_standard_rated A portion of the price is taxed at the standard rate.

      • product_exempt The product or service is nontaxable or exempt from tax.

      • product_exempt_holiday The product or service is not taxed due to a sales tax holiday.

      • proportionally_rated The shipping cost tax rate is calculated as a weighted average of the other line items’ rates, weighted by their amounts.

      • reduced_rated Taxed at a reduced rate.

      • reverse_charge No tax is applied as it is the responsibility of the buyer to account for tax in this case.

      • standard_rated Taxed at the standard rate.

      • taxable_basis_reduced A reduced amount of the price is subject to tax.

      • zero_rated The transaction is taxed at a special rate of 0% or the transaction is exempt (but these exempt transactions still let you deduct the “input VAT” paid on your business purchases).

    • shipping_cost.taxes.taxable_amount (integer, nullable) The amount on which tax is calculated, in cents.

• shipping_options (array of objects) The shipping rate options applied to this Session.

  • shipping_options.shipping_amount (integer) A non-negative integer in cents representing how much to charge.

  • shipping_options.shipping_rate (string) The shipping rate.

• status (enum, nullable) The status of the Checkout Session, one of open, complete, or expired. Possible enum values:

  • complete The checkout session is complete. Payment processing may still be in progress

  • expired The checkout session has expired. No further processing will occur

  • open The checkout session is still in progress. Payment processing has not started

• submit_type (enum, nullable) 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. Possible enum values:

  • auto pay will used for payment mode sessions and subscribe will be used for subscription mode sessions

  • book Recommended when offering bookings. Submit button includes a ‘Book’ label

  • donate Recommended when accepting donations. Submit button includes a ‘Donate’ label

  • pay Submit button includes a ‘Buy’ label

  • subscribe Submit button includes a ‘Subscribe’ label

• subscription (string, nullable) The ID of the Subscription for Checkout Sessions in subscription mode.

• success_url (string, nullable) The URL the customer will be directed to after the payment or subscription creation is successful.

• tax_id_collection (object, nullable) Details on the state of tax ID collection for the session.

  • tax_id_collection.enabled (boolean) Indicates whether tax ID collection is enabled for the session

  • tax_id_collection.required (enum) Indicates whether a tax ID is required on the payment page Possible enum values:

    • if_supported A tax ID will be required if collection is supported for the selected billing address country.

    • never Tax ID collection is never required.

• total_details (object, nullable) Tax and discount details for the computed total amount.

  • total_details.amount_discount (integer) This is the sum of all the discounts.

  • total_details.amount_shipping (integer, nullable) This is the sum of all the shipping amounts.

  • total_details.amount_tax (integer) This is the sum of all the tax amounts.

  • total_details.breakdown (object, nullable) Breakdown of individual tax and discount amounts that add up to the totals.

    • total_details.breakdown.discounts (array of objects) The aggregated discounts.

      • total_details.breakdown.discounts.amount (integer) The amount discounted.

      • total_details.breakdown.discounts.discount (object) The discount applied.

        • total_details.breakdown.discounts.discount.id (string) The ID of the discount object. Discounts cannot be fetched by ID. Use expand[]=discounts in API calls to expand discount IDs in an array.

        • total_details.breakdown.discounts.discount.object (string) String representing the object’s type. Objects of the same type share the same value.

        • total_details.breakdown.discounts.discount.checkout_session (string, nullable) The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.

        • total_details.breakdown.discounts.discount.customer (string, nullable) The ID of the customer associated with this discount.

        • total_details.breakdown.discounts.discount.end (timestamp, nullable) If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null.

        • total_details.breakdown.discounts.discount.invoice (string, nullable) The invoice that the discount’s coupon was applied to, if it was applied directly to a particular invoice.

        • total_details.breakdown.discounts.discount.invoice_item (string, nullable) The invoice item id (or invoice line item id for invoice line items of type=‘subscription’) that the discount’s coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.

        • total_details.breakdown.discounts.discount.promotion_code (string, nullable) The promotion code applied to create this discount.

        • total_details.breakdown.discounts.discount.source (object) The source of the discount.

          • total_details.breakdown.discounts.discount.source.coupon (string, nullable) The coupon that was redeemed to create this discount.

          • total_details.breakdown.discounts.discount.source.type (enum) The source type of the discount. Possible enum values:

            • coupon Coupon source type

        • total_details.breakdown.discounts.discount.start (timestamp) Date that the coupon was applied.

        • total_details.breakdown.discounts.discount.subscription (string, nullable) The subscription that this coupon is applied to, if it is applied to a particular subscription.

        • total_details.breakdown.discounts.discount.subscription_item (string, nullable) The subscription item that this coupon is applied to, if it is applied to a particular subscription item.

    • total_details.breakdown.taxes (array of objects) The aggregated tax amounts by rate.

      • total_details.breakdown.taxes.amount (integer) Amount of tax applied for this rate.

      • total_details.breakdown.taxes.rate (object) The tax rate applied.

        • total_details.breakdown.taxes.rate.id (string) Unique identifier for the object.

        • total_details.breakdown.taxes.rate.object (string) String representing the object’s type. Objects of the same type share the same value.

        • total_details.breakdown.taxes.rate.active (boolean) Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.

        • total_details.breakdown.taxes.rate.country (string, nullable) Two-letter country code (ISO 3166-1 alpha-2).

        • total_details.breakdown.taxes.rate.created (timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.

        • total_details.breakdown.taxes.rate.description (string, nullable) An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.

        • total_details.breakdown.taxes.rate.display_name (string) The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.

        • total_details.breakdown.taxes.rate.effective_percentage (float, nullable) Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product’s taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.

        • total_details.breakdown.taxes.rate.flat_amount (object, nullable) The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.

          • total_details.breakdown.taxes.rate.flat_amount.amount (integer) Amount of the tax when the rate_type is flat_amount. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

          • total_details.breakdown.taxes.rate.flat_amount.currency (string) Three-letter ISO currency code, in lowercase.

        • total_details.breakdown.taxes.rate.inclusive (boolean) This specifies if the tax rate is inclusive or exclusive.

        • total_details.breakdown.taxes.rate.jurisdiction (string, nullable) The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.

        • total_details.breakdown.taxes.rate.jurisdiction_level (enum, nullable) The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates. Possible enum values:

          • city
          • country
          • county
          • district
          • multiple
          • state

        • total_details.breakdown.taxes.rate.livemode (boolean) Has the value true if the object exists in live mode or the value false if the object exists in test mode.

        • total_details.breakdown.taxes.rate.metadata (object, nullable) Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

        • total_details.breakdown.taxes.rate.percentage (float) Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.

        • total_details.breakdown.taxes.rate.rate_type (enum, nullable) Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. Possible enum values:

          • flat_amount A fixed amount applied as tax, regardless of the taxable amount, such as a retail delivery fee.

          • percentage A tax rate expressed as a percentage of the taxable amount, such as the sales tax rate in California.

        • total_details.breakdown.taxes.rate.state (string, nullable) ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.

        • total_details.breakdown.taxes.rate.tax_type (enum, nullable) The high-level tax type, such as vat or sales_tax. Possible enum values:

          • amusement_tax Amusement Tax

          • communications_tax Communications Tax

          • gst Goods and Services Tax

          • hst Harmonized Sales Tax

          • igst Integrated Goods and Services Tax

          • jct Japanese Consumption Tax

          • lease_tax Chicago Lease Tax

          • pst Provincial Sales Tax

          • qst Quebec Sales Tax

          • retail_delivery_fee Retail Delivery Fee

          • rst Retail Sales Tax

          • sales_tax Sales Tax

          • service_tax Service Tax

          • vat Value-Added Tax

      • total_details.breakdown.taxes.taxability_reason (enum, nullable) The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. Possible enum values:

        • customer_exempt No tax is applied as the customer is exempt from tax.

        • not_collecting No tax is collected either because you are not registered to collect tax in this jurisdiction, or because the non-taxable product tax code (txcd_00000000) was used.

        • not_subject_to_tax No tax is imposed on this transaction.

        • not_supported No tax applied. Stripe doesn’t support this jurisdiction, territory, or product.

        • portion_product_exempt A portion of the price is exempt from tax.

        • portion_reduced_rated A portion of the price is taxed at a reduced rate.

        • portion_standard_rated A portion of the price is taxed at the standard rate.

        • product_exempt The product or service is nontaxable or exempt from tax.

        • product_exempt_holiday The product or service is not taxed due to a sales tax holiday.

        • proportionally_rated The shipping cost tax rate is calculated as a weighted average of the other line items’ rates, weighted by their amounts.

        • reduced_rated Taxed at a reduced rate.

        • reverse_charge No tax is applied as it is the responsibility of the buyer to account for tax in this case.

        • standard_rated Taxed at the standard rate.

        • taxable_basis_reduced A reduced amount of the price is subject to tax.

        • zero_rated The transaction is taxed at a special rate of 0% or the transaction is exempt (but these exempt transactions still let you deduct the “input VAT” paid on your business purchases).

      • total_details.breakdown.taxes.taxable_amount (integer, nullable) The amount on which tax is calculated, in cents.

• ui_mode (enum, nullable) The UI mode of the Session. Defaults to hosted. Possible enum values:

  • custom The Checkout Session will be displayed using embedded components on your website

  • embedded The Checkout Session will be displayed as an embedded form on your website.

  • hosted The Checkout Session will be displayed on a hosted page that customers will be redirected to.

• url (string, nullable) The URL to the Checkout Session. Applies to Checkout Sessions with ui_mode: hosted. Redirect customers to this URL to take them to Checkout. If you’re using 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_options (object, nullable) Wallet-specific configuration for this Checkout Session.

  • wallet_options.link (object, nullable) This hash contains the configurations that will be applied to the wallet of this type.

    • wallet_options.link.display (enum, nullable) Describes whether Checkout should display Link. Defaults to auto. Possible enum values:

      • auto The Checkout Session will automatically determine if Link is a supported payment option and display accordingly.

      • never The Checkout Session will not display Link as a payment option.

The Checkout Session object

{
  "id": "cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u",
  "object": "checkout.session",
  "after_expiration": null,
  "allow_promotion_codes": null,
  "amount_subtotal": 2198,
  "amount_total": 2198,
  "automatic_tax": {
    "enabled": false,
    "liability": null,
    "status": null
  },
  "billing_address_collection": null,
  "cancel_url": null,
  "client_reference_id": null,
  "consent": null,
  "consent_collection": null,
  "created": 1679600215,
  "currency": "usd",
  "custom_fields": [],
  "custom_text": {
    "shipping_address": null,
    "submit": null
  },
  "customer": null,
  "customer_creation": "if_required",
  "customer_details": null,
  "customer_email": null,
  "expires_at": 1679686615,
  "invoice": null,
  "invoice_creation": {
    "enabled": false,
    "invoice_data": {
      "account_tax_ids": null,
      "custom_fields": null,
      "description": null,
      "footer": null,
      "issuer": null,
      "metadata": {},
      "rendering_options": null
    }
  },
  "livemode": false,
  "locale": null,
  "metadata": {},
  "mode": "payment",
  "payment_intent": null,
  "payment_link": null,
  "payment_method_collection": "always",
  "payment_method_options": {},
  "payment_method_types": [
    "card"
  ],
  "payment_status": "unpaid",
  "phone_number_collection": {
    "enabled": false
  },
  "recovered_from": null,
  "setup_intent": null,
  "shipping_address_collection": null,
  "shipping_cost": null,
  "shipping_details": null,
  "shipping_options": [],
  "status": "open",
  "submit_type": null,
  "subscription": null,
  "success_url": "https://example.com/success",
  "total_details": {
    "amount_discount": 0,
    "amount_shipping": 0,
    "amount_tax": 0
  },
  "url": "https://checkout.stripe.com/c/pay/cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u#fidkdWxOYHwnPyd1blpxYHZxWjA0SDdPUW5JbmFMck1wMmx9N2BLZjFEfGRUNWhqTmJ%2FM2F8bUA2SDRySkFdUV81T1BSV0YxcWJcTUJcYW5rSzN3dzBLPUE0TzRKTTxzNFBjPWZEX1NKSkxpNTVjRjN8VHE0YicpJ2N3amhWYHdzYHcnP3F3cGApJ2lkfGpwcVF8dWAnPyd2bGtiaWBabHFgaCcpJ2BrZGdpYFVpZGZgbWppYWB3dic%2FcXdwYHgl"
}

Create a Checkout Session

Creates a Checkout Session object.

Returns

Returns a Checkout Session object.

Parameters

• adaptive_pricing (object, optional) Settings for price localization with Adaptive Pricing.

  • adaptive_pricing.enabled (boolean, optional) If set to true, Adaptive Pricing is available on eligible sessions. Defaults to your dashboard setting.

• after_expiration (object, optional) Configure actions after a Checkout Session has expired.

  • after_expiration.recovery (object, optional) Configure a Checkout Session that can be used to recover an expired session.

    • after_expiration.recovery.enabled (boolean, required) If true, a recovery URL will be generated to recover this Checkout Session if it expires before a successful transaction is completed. It will be attached to the Checkout Session object upon expiration.

    • after_expiration.recovery.allow_promotion_codes (boolean, optional) Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to false

• allow_promotion_codes (boolean, optional) Enables user redeemable promotion codes.

• automatic_tax (object, optional) Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.

  • automatic_tax.enabled (boolean, required) Set to true to calculate tax automatically using the customer’s location.

    Enabling this parameter causes Checkout to collect any billing address information necessary for tax calculation.

  • automatic_tax.liability (object, optional) The account that’s liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.

    • automatic_tax.liability.type (enum, required) Type of the account referenced in the request. Possible enum values:

      • account Indicates that the account being referenced is a connected account which is different from the account making the API request but related to it.

      • self Indicates that the account being referenced is the account making the API request.

    • automatic_tax.liability.account (string, required only if type is account) The connected account being referenced when type is account.

• billing_address_collection (enum, optional) Specify whether Checkout should collect the customer’s billing address. Defaults to auto. Possible enum values:

  • auto Checkout will only collect the billing address when necessary. When using automatic_tax, Checkout will collect the minimum number of fields required for tax calculation.

  • required Checkout will always collect the customer’s billing address.

• branding_settings (object, optional) The branding settings for the Checkout Session. This parameter is not allowed if ui_mode is custom.

  • branding_settings.background_color (string, optional) A hex color value starting with # representing the background color for the Checkout Session.

  • branding_settings.border_style (enum, optional) The border style for the Checkout Session. Possible enum values:

    • pill Uses pill-shaped corners on the Checkout Session.

    • rectangular Uses rectangular corners on the Checkout Session.

    • rounded Uses rounded corners on the Checkout Session.

  • branding_settings.button_color (string, optional) A hex color value starting with # representing the button color for the Checkout Session.

  • branding_settings.display_name (string, optional) A string to override the business name shown on the Checkout Session. This only shows at the top of the Checkout page, and your business name still appears in terms, receipts, and other places.

  • branding_settings.font_family (enum, optional) The font family for the Checkout Session corresponding to one of the supported font families. Possible enum values:

    • be_vietnam_pro The Be Vietnam Pro font family.

    • bitter The Bitter font family.

    • chakra_petch The Chakra Petch font family.

    • default The default font family.

    • hahmlet The Hahmlet font family.

    • inconsolata The Inconsolata font family.

    • inter The Inter font family.

    • lato The Lato font family.

    • lora The Lora font family.

    • m_plus_1_code The M PLUS 1 Code font family.

    • montserrat The Montserrat font family.

    • noto_sans The Noto Sans font family.

    • noto_sans_jp The Noto Sans JP font family.

    • noto_serif The Noto Serif font family.

    • nunito The Nunito font family.

    • open_sans The Open Sans font family.

    • pridi The Pridi font family.

    • pt_sans The PT Sans font family.

    • pt_serif The PT Serif font family.

    • raleway The Raleway font family.

    • roboto The Roboto font family.

    • roboto_slab The Roboto Slab font family.

    • source_sans_pro The Source Sans Pro font family.

    • titillium_web The Titillium Web font family.

    • ubuntu_mono The Ubuntu Mono font family.

    • zen_maru_gothic The Zen Maru Gothic font family.

  • branding_settings.icon (object, optional) The icon for the Checkout Session. For best results, use a square image.

    • branding_settings.icon.type (enum, required) The type of image for the icon. Must be one of file or url.

    • branding_settings.icon.file (string, optional) The ID of a File upload representing the icon. Purpose must be business_icon. Required if type is file and disallowed otherwise.

    • branding_settings.icon.url (string, optional) The URL of the image. Required if type is url and disallowed otherwise.

  • branding_settings.logo (object, optional) The logo for the Checkout Session.

    • branding_settings.logo.type (enum, required) The type of image for the logo. Must be one of file or url.

    • branding_settings.logo.file (string, optional) The ID of a File upload representing the logo. Purpose must be business_logo. Required if type is file and disallowed otherwise.

    • branding_settings.logo.url (string, optional) The URL of the image. Required if type is url and disallowed otherwise.

• 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 or custom.

• 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.

• consent_collection (object, optional) Configure fields for the Checkout Session to gather active consent from customers.

  • consent_collection.payment_method_reuse_agreement (object, optional) Determines the display of payment method reuse agreement text in the UI. If set to hidden, it will hide legal text related to the reuse of a payment method.

    • consent_collection.payment_method_reuse_agreement.position (enum, required) Determines the position and visibility of the payment method reuse agreement in the UI. When set to auto, Stripe’s defaults will be used. When set to hidden, the payment method reuse agreement text will always be hidden in the UI. Possible enum values:

      • auto Uses Stripe defaults to determine the visibility and position of the payment method reuse agreement.

      • hidden Hides the payment method reuse agreement.

  • consent_collection.promotions (enum, optional) If set to auto, enables the collection of customer consent for promotional communications. The Checkout Session will determine whether to display an option to opt into promotional communication from the merchant depending on the customer’s locale. Only available to US merchants. Possible enum values:

    • auto Enable the collection of customer consent for promotional communications. The Checkout Session will determine whether to display an option to opt into promotional communication from the merchant depending on if a customer is provided, and if that customer has consented to receiving promotional communications from the merchant in the past.

    • none Checkout will not collect customer consent for promotional communications.

  • consent_collection.terms_of_service (enum, optional) If set to required, it requires customers to check a terms of service checkbox before being able to pay. There must be a valid terms of service URL set in your Dashboard settings. Possible enum values:

    • none Does not display checkbox for the terms of service agreement.

    • required Displays a checkbox for the terms of service agreement which requires customer to check before being able to pay.

• currency (enum, required conditionally) Three-letter ISO currency code, in lowercase. Must be a supported currency. Required in setup mode when payment_method_types is not set.

• custom_fields (array of objects, optional) Collect additional information from your customer using custom fields. Up to 3 fields are supported.

  • custom_fields.key (string, required) String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.

  • custom_fields.label (object, required) The label for the field, displayed to the customer.

    • custom_fields.label.custom (string, required) Custom text for the label, displayed to the customer. Up to 50 characters.

    • custom_fields.label.type (enum, required) The type of the label. Possible enum values:

      • custom Set a custom label for the field.

  • custom_fields.type (enum, required) The type of the field. Possible enum values:

    • dropdown Provide a list of options for your customer to select.

    • numeric Collect a numbers-only field from your customer.

    • text Collect a string field from your customer.

  • custom_fields.dropdown (object, optional) Configuration for type=dropdown fields.

    • custom_fields.dropdown.options (array of objects, required) The options available for the customer to select. Up to 200 options allowed.

      • custom_fields.dropdown.options.label (string, required) The label for the option, displayed to the customer. Up to 100 characters.

      • custom_fields.dropdown.options.value (string, required) The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.

    • custom_fields.dropdown.default_value (string, optional) The value that will pre-fill the field on the payment page.Must match a value in the options array.

  • custom_fields.numeric (object, optional) Configuration for type=numeric fields.

    • custom_fields.numeric.default_value (string, optional) The value that will pre-fill the field on the payment page.

    • custom_fields.numeric.maximum_length (integer, optional) The maximum character length constraint for the customer’s input.

    • custom_fields.numeric.minimum_length (integer, optional) The minimum character length requirement for the customer’s input.

  • custom_fields.optional (boolean, optional) Whether the customer is required to complete the field before completing the Checkout Session. Defaults to false.

  • custom_fields.text (object, optional) Configuration for type=text fields.

    • custom_fields.text.default_value (string, optional) The value that will pre-fill the field on the payment page.

    • custom_fields.text.maximum_length (integer, optional) The maximum character length constraint for the customer’s input.

    • custom_fields.text.minimum_length (integer, optional) The minimum character length requirement for the customer’s input.

• custom_text (object, optional) Display additional text for your customers using custom text.

  • custom_text.after_submit (object, optional) Custom text that should be displayed after the payment confirmation button.

    • custom_text.after_submit.message (string, required) Text may be up to 1200 characters in length.

  • custom_text.shipping_address (object, optional) Custom text that should be displayed alongside shipping address collection.

    • custom_text.shipping_address.message (string, required) Text may be up to 1200 characters in length.

  • custom_text.submit (object, optional) Custom text that should be displayed alongside the payment confirmation button.

    • custom_text.submit.message (string, required) Text may be up to 1200 characters in length.

  • custom_text.terms_of_service_acceptance (object, optional) Custom text that should be displayed in place of the default terms of service agreement text.

    • custom_text.terms_of_service_acceptance.message (string, required) Text may be up to 1200 characters in length.

• 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 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 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 to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.

• customer_creation (enum, optional) Configure whether a Checkout Session creates a Customer 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.

  Sessions that don’t create Customers instead are grouped by 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. Possible enum values:

  • always The Checkout Session will always create a Customer when a Session confirmation is attempted.

  • if_required The Checkout Session will only create a Customer if it is required for Session confirmation. Currently, only subscription mode Sessions and payment mode Sessions with post-purchase invoices enabled require a Customer.

• 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.

• customer_update (object, optional) Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when customer is provided.

  • customer_update.address (enum, optional) Describes whether Checkout saves the billing address onto customer.address. To always collect a full billing address, use billing_address_collection. Defaults to never. Possible enum values:

    • auto Checkout will automatically determine whether to update the provided Customer object using details from the session.

    • never Checkout will never update the provided Customer object.

  • customer_update.name (enum, optional) Describes whether Checkout saves the name onto customer.name. Defaults to never. Possible enum values:

    • auto Checkout will automatically determine whether to update the provided Customer object using details from the session.

    • never Checkout will never update the provided Customer object.

  • customer_update.shipping (enum, optional) Describes whether Checkout saves shipping information onto customer.shipping. To collect shipping information, use shipping_address_collection. Defaults to never. Possible enum values:

    • auto Checkout will automatically determine whether to update the provided Customer object using details from the session.

    • never Checkout will never update the provided Customer object.

• discounts (array of objects, optional) The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.

  • discounts.coupon (string, optional) The ID of the coupon to apply to this Session.

  • discounts.promotion_code (string, optional) The ID of a promotion code to apply to this Session.

• excluded_payment_method_types (array of enums, 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.

• expires_at (timestamp, 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.

• invoice_creation (object, optional) Generate a post-purchase Invoice for one-time payments.

  • invoice_creation.enabled (boolean, required) Set to true to enable invoice creation.

  • invoice_creation.invoice_data (object, optional) Parameters passed when creating invoices for payment-mode Checkout Sessions.

    • invoice_creation.invoice_data.account_tax_ids (array of strings, optional) The account tax IDs associated with the invoice.

    • invoice_creation.invoice_data.custom_fields (array of objects, optional) Default custom fields to be displayed on invoices for this customer.

      • invoice_creation.invoice_data.custom_fields.name (string, required) The name of the custom field. This may be up to 40 characters.

      • invoice_creation.invoice_data.custom_fields.value (string, required) The value of the custom field. This may be up to 140 characters.

    • invoice_creation.invoice_data.description (string, optional) An arbitrary string attached to the object. Often useful for displaying to users.

    • invoice_creation.invoice_data.footer (string, optional) Default footer to be displayed on invoices for this customer.

    • invoice_creation.invoice_data.issuer (object, optional) The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.

      • invoice_creation.invoice_data.issuer.type (enum, required) Type of the account referenced in the request. Possible enum values:

        • account Indicates that the account being referenced is a connected account which is different from the account making the API request but related to it.

        • self Indicates that the account being referenced is the account making the API request.

      • invoice_creation.invoice_data.issuer.account (string, required only if type is account) The connected account being referenced when type is account.

    • invoice_creation.invoice_data.metadata (object, optional) Set of key-value pairs 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.

    • invoice_creation.invoice_data.rendering_options (object, optional) Default options for invoice PDF rendering for this customer.

      • invoice_creation.invoice_data.rendering_options.amount_tax_display (enum, optional) How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of exclude_tax or include_inclusive_tax. include_inclusive_tax will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. exclude_tax will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts. Possible enum values:

        • exclude_tax
        • include_inclusive_tax

      • invoice_creation.invoice_data.rendering_options.template (string, optional) ID of the invoice rendering template to use for this invoice.

• line_items (array of objects, required conditionally) A list of items the customer is purchasing. Use this parameter to pass one-time or recurring 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.

  • line_items.adjustable_quantity (object, optional) When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.

    • line_items.adjustable_quantity.enabled (boolean, required) Set to true if the quantity can be adjusted to any non-negative integer.

    • line_items.adjustable_quantity.maximum (integer, optional) The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999.

    • line_items.adjustable_quantity.minimum (integer, optional) The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.

  • line_items.dynamic_tax_rates (array of strings, optional) The tax rates that will be applied to this line item depending on the customer’s billing/shipping address. We currently support the following countries: US, GB, AU, and all countries in the EU.

  • line_items.price (string, required conditionally) The ID of the Price or Plan object. One of price or price_data is required.

  • line_items.price_data (object, required conditionally) Data used to generate a new Price object inline. One of price or price_data is required.

    • line_items.price_data.currency (enum, required) Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • line_items.price_data.product (string, required conditionally) The ID of the Product that this Price will belong to. One of product or product_data is required.

    • line_items.price_data.product_data (object, required conditionally) Data used to generate a new Product object inline. One of product or product_data is required.

      • line_items.price_data.product_data.name (string, required) The product’s name, meant to be displayable to the customer.

      • line_items.price_data.product_data.description (string, optional) The product’s description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.

      • line_items.price_data.product_data.images (array of strings, optional) A list of up to 8 URLs of images for this product, meant to be displayable to the customer.

      • line_items.price_data.product_data.metadata (object, optional) Set of key-value pairs 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.

      • line_items.price_data.product_data.tax_code (string, recommended if calculating taxes) A tax code ID.

      • line_items.price_data.product_data.unit_label (string, optional) A label that represents units of this product. When set, this will be included in customers’ receipts, invoices, Checkout, and the customer portal.

    • line_items.price_data.recurring (object, optional) The recurring components of a price such as interval and interval_count.

      • line_items.price_data.recurring.interval (enum, required) Specifies billing frequency. Either day, week, month or year. Possible enum values:

        • day
        • month
        • week
        • year

      • line_items.price_data.recurring.interval_count (integer, optional) The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).

    • line_items.price_data.tax_behavior (enum, recommended if calculating taxes) Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed. Possible enum values:

      • exclusive
      • inclusive
      • unspecified

    • line_items.price_data.unit_amount (integer, required conditionally) A non-negative integer in cents representing how much to charge. One of unit_amount or unit_amount_decimal is required.

    • line_items.price_data.unit_amount_decimal (string, required conditionally) Same as unit_amount, but accepts a decimal value in cents with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.

  • line_items.quantity (integer, required conditionally) The quantity of the line item being purchased. Quantity should not be defined when recurring.usage_type=metered.

  • line_items.tax_rates (array of strings, optional) The tax rates which apply to this line item.

• locale (enum, optional) The IETF language tag of the locale Checkout is displayed in. If blank or auto, the browser’s locale is used. Possible enum values:

  • 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

• metadata (object, optional) Set of key-value pairs 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.

• mode (enum, required) The mode of the Checkout Session. Pass subscription if the Checkout Session includes at least one recurring item. Possible enum values:

  • payment Accept one-time payments for cards, iDEAL, and more.

  • setup Save payment details to charge your customers later.

  • subscription Use Stripe Billing to set up fixed-price subscriptions.

• 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 is created or provided, the names can be saved to the Customer object as well.

  • name_collection.business (object, optional) Controls settings applied for collecting the customer’s business name on the session.

    • name_collection.business.enabled (boolean, required) Enable business name collection on the Checkout Session. Defaults to false.

    • name_collection.business.optional (boolean, optional) Whether the customer is required to provide a business name before completing the Checkout Session. Defaults to false.

  • name_collection.individual (object, optional) Controls settings applied for collecting the customer’s individual name on the session.

    • name_collection.individual.enabled (boolean, required) Enable individual name collection on the Checkout Session. Defaults to false.

    • name_collection.individual.optional (boolean, optional) Whether the customer is required to provide their name before completing the Checkout Session. Defaults to false.

• optional_items (array of objects, 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.

  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.

  • optional_items.price (string, required) The ID of the Price or Plan object.

  • optional_items.quantity (integer, required) The initial quantity of the line item created when a customer chooses to add this optional item to their order.

  • optional_items.adjustable_quantity (object, optional) When set, provides configuration for the customer to adjust the quantity of the line item created when a customer chooses to add this optional item to their order.

    • optional_items.adjustable_quantity.enabled (boolean, required) Set to true if the quantity can be adjusted to any non-negative integer.

    • optional_items.adjustable_quantity.maximum (integer, optional) The maximum quantity of this item the customer can purchase. By default this value is 99. You can specify a value up to 999999.

    • optional_items.adjustable_quantity.minimum (integer, optional) The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the minimum configured here is greater than 0. By default this value is 0.

• origin_context (enum, optional) Where the user is coming from. This informs the optimizations that are applied to the session. Possible enum values:

  • mobile_app The Checkout Session originates from a mobile app.

  • web The Checkout Session originates from a web page.

• payment_intent_data (object, optional) A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in payment mode.

  • payment_intent_data.application_fee_amount (integer, optional) The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner’s Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents use case for connected accounts.

  • payment_intent_data.capture_method (enum, optional) Controls when the funds will be captured from the customer’s account. Possible enum values:

    • automatic Stripe automatically captures funds when the customer authorizes the payment.

    • automatic_async (Default) Stripe asynchronously captures funds when the customer authorizes the payment. Recommended over capture_method=automatic due to improved latency. Read the integration guide for more information.

    • manual Place a hold on the funds when the customer authorizes the payment, but don’t capture the funds until later. (Not all payment methods support this.)

  • payment_intent_data.description (string, optional) An arbitrary string attached to the object. Often useful for displaying to users.

  • payment_intent_data.metadata (object, optional) Set of key-value pairs 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.

  • payment_intent_data.on_behalf_of (string, optional) The Stripe account ID for which these funds are intended. For details, see the PaymentIntents use case for connected accounts.

  • payment_intent_data.receipt_email (string, optional) Email address that the receipt for the resulting payment will be sent to. If receipt_email is specified for a payment in live mode, a receipt will be sent regardless of your email settings.

  • payment_intent_data.setup_future_usage (enum, optional) Indicates that you intend to make future payments with the payment method collected by this Checkout Session.

    When setting this to on_session, Checkout will show a notice to the customer that their payment details will be saved.

    When setting this to off_session, Checkout will show a notice to the customer that their payment details will be saved and used for future payments.

    If a Customer has been provided or Checkout creates a new Customer, Checkout will attach the payment method to the Customer.

    If Checkout does not create a Customer, the payment method is not attached to a Customer. To reuse the payment method, you can retrieve it from the Checkout Session’s PaymentIntent.

    When processing card payments, Checkout also uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA. Possible enum values:

    • off_session Use off_session if your customer may or may not be present in your checkout flow.

    • on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

  • payment_intent_data.shipping (object, optional) Shipping information for this payment.

    • payment_intent_data.shipping.address (object, required) Shipping address.

      • payment_intent_data.shipping.address.line1 (string, required) Address line 1, such as the street, PO Box, or company name.

      • payment_intent_data.shipping.address.city (string, optional) City, district, suburb, town, or village.

      • payment_intent_data.shipping.address.country (string, optional) Two-letter country code (ISO 3166-1 alpha-2).

      • payment_intent_data.shipping.address.line2 (string, optional) Address line 2, such as the apartment, suite, unit, or building.

      • payment_intent_data.shipping.address.postal_code (string, optional) ZIP or postal code.

      • payment_intent_data.shipping.address.state (string, optional) State, county, province, or region.

    • payment_intent_data.shipping.name (string, required) Recipient name.

    • payment_intent_data.shipping.carrier (string, optional) The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.

    • payment_intent_data.shipping.phone (string, optional) Recipient phone (including extension).

    • payment_intent_data.shipping.tracking_number (string, optional) The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

  • payment_intent_data.statement_descriptor (string, optional) Text that appears on the customer’s statement as the statement descriptor for a non-card charge. This value overrides the account’s default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs.

    Setting this value for a card charge returns an error. For card charges, set the statement_descriptor_suffix instead.

  • payment_intent_data.statement_descriptor_suffix (string, optional) Provides information about a card charge. Concatenated to the account’s statement descriptor prefix to form the complete statement descriptor that appears on the customer’s statement.

  • payment_intent_data.transfer_data (object, optional) The parameters used to automatically create a Transfer when the payment succeeds. For more information, see the PaymentIntents use case for connected accounts.

    • payment_intent_data.transfer_data.destination (string, required) If specified, successful charges will be attributed to the destination account for tax reporting, and the funds from charges will be transferred to the destination account. The ID of the resulting transfer will be returned on the successful charge’s transfer field.

    • payment_intent_data.transfer_data.amount (integer, optional) The amount that will be transferred automatically when a charge succeeds.

  • payment_intent_data.transfer_group (string, optional) A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.

• payment_method_collection (enum, 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. Possible enum values:

  • always The Checkout Session will always collect a PaymentMethod.

  • if_required The Checkout Session will only collect a PaymentMethod if there is an amount due.

• payment_method_configuration (string, optional) The ID of the payment method configuration to use with this Checkout session.

• payment_method_data (object, optional) This parameter allows you to set some attributes on the payment method created during a Checkout session.

  • payment_method_data.allow_redisplay (enum, optional) Allow redisplay will be set on the payment method on confirmation and indicates whether this payment method can be shown again to the customer in a checkout flow. Only set this field if you wish to override the allow_redisplay value determined by Checkout. Possible enum values:

    • always Use always to indicate that this payment method can always be shown to a customer in a checkout flow.

    • limited Use limited to indicate that this payment method can’t always be shown to a customer in a checkout flow. For example, it can only be shown in the context of a specific subscription.

    • unspecified This is the default value for payment methods where allow_redisplay wasn’t set.

• payment_method_options (object, optional) Payment-method-specific configuration.

  • payment_method_options.acss_debit (object, optional) contains details about the ACSS Debit payment method options.

    • payment_method_options.acss_debit.currency (enum, optional) Three-letter ISO currency code, in lowercase. Must be a supported currency. This is only accepted for Checkout Sessions in setup mode. Possible enum values:

      • cad Canadian dollars

      • usd US dollars

    • payment_method_options.acss_debit.mandate_options (object, optional) Additional fields for Mandate creation

      • payment_method_options.acss_debit.mandate_options.custom_mandate_url (string, optional) A URL for custom mandate text to render during confirmation step. The URL will be rendered with additional GET parameters payment_intent and payment_intent_client_secret when confirming a Payment Intent, or setup_intent and setup_intent_client_secret when confirming a Setup Intent.

      • payment_method_options.acss_debit.mandate_options.default_for (array of enums, optional) List of Stripe products where this mandate can be selected automatically. Only usable in setup mode. Possible enum values:

        • invoice Enables payments for Stripe Invoices. ‘subscription’ must also be provided.

        • subscription Enables payments for Stripe Subscriptions. ‘invoice’ must also be provided.

      • payment_method_options.acss_debit.mandate_options.interval_description (string, optional) Description of the mandate interval. Only required if ‘payment_schedule’ parameter is ‘interval’ or ‘combined’.

      • payment_method_options.acss_debit.mandate_options.payment_schedule (enum, optional) Payment schedule for the mandate. Possible enum values:

        • combined Payments can be initiated at a pre-defined interval or sporadically

        • interval Payments are initiated at a regular pre-defined interval

        • sporadic Payments are initiated sporadically

      • payment_method_options.acss_debit.mandate_options.transaction_type (enum, optional) Transaction type of the mandate. Possible enum values:

        • business Transactions are made for business reasons

        • personal Transactions are made for personal reasons

    • payment_method_options.acss_debit.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

      • on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

    • payment_method_options.acss_debit.target_date (string, optional) Controls when Stripe will attempt to debit the funds from the customer’s account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.

    • payment_method_options.acss_debit.verification_method (enum, optional) Verification method for the intent Possible enum values:

      • automatic Instant verification with fallback to microdeposits.

      • instant Instant verification.

      • microdeposits Verification using microdeposits.

  • payment_method_options.affirm (object, optional) contains details about the Affirm payment method options.

    • payment_method_options.affirm.capture_method (enum, optional) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.affirm.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.afterpay_clearpay (object, optional) contains details about the Afterpay Clearpay payment method options.

    • payment_method_options.afterpay_clearpay.capture_method (enum, optional) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.afterpay_clearpay.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.alipay (object, optional) contains details about the Alipay payment method options.

    • payment_method_options.alipay.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.alma (object, optional) contains details about the Alma payment method options.

    • payment_method_options.alma.capture_method (enum, optional) Controls when the funds will be captured from the customer’s account. Possible enum values:
      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

  • payment_method_options.amazon_pay (object, optional) contains details about the AmazonPay payment method options.

    • payment_method_options.amazon_pay.capture_method (enum, optional) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.amazon_pay.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.au_becs_debit (object, optional) contains details about the AU Becs Debit payment method options.

    • payment_method_options.au_becs_debit.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

    • payment_method_options.au_becs_debit.target_date (string, optional) Controls when Stripe will attempt to debit the funds from the customer’s account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.

  • payment_method_options.bacs_debit (object, optional) contains details about the Bacs Debit payment method options.

    • payment_method_options.bacs_debit.mandate_options (object, optional) Additional fields for Mandate creation

      • payment_method_options.bacs_debit.mandate_options.reference_prefix (string, optional) Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: ‘/’, ‘_’, ‘-’, ‘&’, ‘.’. Cannot begin with ‘DDIC’ or ‘STRIPE’.

    • payment_method_options.bacs_debit.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

      • on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

    • payment_method_options.bacs_debit.target_date (string, optional) Controls when Stripe will attempt to debit the funds from the customer’s account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.

  • payment_method_options.bancontact (object, optional) contains details about the Bancontact payment method options.

    • payment_method_options.bancontact.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.billie (object, optional) contains details about the Billie payment method options.

    • payment_method_options.billie.capture_method (enum, optional) Controls when the funds will be captured from the customer’s account. Possible enum values:
      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

  • payment_method_options.boleto (object, optional) contains details about the Boleto payment method options.

    • payment_method_options.boleto.expires_after_days (integer, optional) The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.

    • payment_method_options.boleto.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

      • on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

  • payment_method_options.card (object, optional) contains details about the Card payment method options.

    • payment_method_options.card.capture_method (enum, optional) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.card.installments (object, optional) Installment options for card payments

      • payment_method_options.card.installments.enabled (boolean, optional) Setting to true enables installments for this Checkout Session. Setting to false will prevent any installment plan from applying to a payment.

    • payment_method_options.card.request_extended_authorization (enum, optional) Request ability to capture beyond the standard authorization validity window for this CheckoutSession. Possible enum values:

      • if_available Use if_available if you want to extend the capture window when eligible for extended authorization.

      • never Use never if you don’t want to extend the capture window.

    • payment_method_options.card.request_incremental_authorization (enum, optional) Request ability to increment the authorization for this CheckoutSession. Possible enum values:

      • if_available Use if_available if you want to increment the authorization on the PaymentIntent when eligible.

      • never Use never if you don’t want to increment the authorization on the PaymentIntent.

    • payment_method_options.card.request_multicapture (enum, optional) Request ability to make multiple captures for this CheckoutSession. Possible enum values:

      • if_available Use if_available if you want to use multicapture when eligible.

      • never Use never if you don’t want to use multicapture.

    • payment_method_options.card.request_overcapture (enum, optional) Request ability to overcapture for this CheckoutSession. Possible enum values:

      • if_available Use if_available if you want to overcapture the payment when eligible.

      • never Use never if you don’t want to overcapture the payment.

    • payment_method_options.card.request_three_d_secure (enum, optional) We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to automatic. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine. Possible enum values:

      • any Use any to manually request 3DS with a preference for a frictionless flow, increasing the likelihood of the authentication being completed without any additional input from the customer. 3DS will always be attempted if it is supported for the card, but Stripe can’t guarantee your preference because the issuer determines the ultimate authentication flow. To learn more about 3DS flows, read our guide.

      • automatic (Default) Our SCA Engine automatically prompts your customers for authentication based on risk level and other requirements.

      • challenge Use challenge to request 3DS with a preference for a challenge flow, where the customer must respond to a prompt for active authentication. Stripe can’t guarantee your preference because the issuer determines the ultimate authentication flow. To learn more about 3DS flows, read our guide.

    • payment_method_options.card.restrictions (object, optional) Restrictions to apply to the card payment method. For example, you can block specific card brands.

      • payment_method_options.card.restrictions.brands_blocked (array of enums, optional) Specify the card brands to block in the Checkout Session. If a customer enters or selects a card belonging to a blocked brand, they can’t complete the Session. Possible enum values:

        • american_express Include american_express to block American Express cards.

        • discover_global_network Include discover_global_network to block all cards within the Discover Global Network. This encompasses the following card brands:

          • Discover
          • Diners Club
          • JCB
          • UnionPay
          • Elo

        • mastercard Include mastercard to block Mastercard cards.

        • visa Include visa to block Visa cards.

    • payment_method_options.card.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

      • on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

    • payment_method_options.card.statement_descriptor_suffix_kana (string, optional) Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the concatenation of both prefix and suffix (including separators) will appear truncated to 22 characters.

    • payment_method_options.card.statement_descriptor_suffix_kanji (string, optional) Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the concatenation of both prefix and suffix (including separators) will appear truncated to 17 characters.

  • payment_method_options.cashapp (object, optional) contains details about the Cashapp Pay payment method options.

    • payment_method_options.cashapp.capture_method (enum, optional) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.cashapp.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

      • on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

  • payment_method_options.customer_balance (object, optional) contains details about the Customer Balance payment method options.

    • payment_method_options.customer_balance.bank_transfer (object, optional) Configuration for the bank transfer funding type, if the funding_type is set to bank_transfer.

      • payment_method_options.customer_balance.bank_transfer.type (enum, required) The list of bank transfer types that this PaymentIntent is allowed to use for funding. Possible enum values:

        • eu_bank_transfer eu_bank_transfer bank transfer type

        • gb_bank_transfer gb_bank_transfer bank transfer type

        • jp_bank_transfer jp_bank_transfer bank transfer type

        • mx_bank_transfer mx_bank_transfer bank transfer type

        • us_bank_transfer us_bank_transfer bank transfer type

      • payment_method_options.customer_balance.bank_transfer.eu_bank_transfer (object, optional) Configuration for eu_bank_transfer funding type.

        • payment_method_options.customer_balance.bank_transfer.eu_bank_transfer.country (string, required) The desired country code of the bank account information. Permitted values include: BE, DE, ES, FR, IE, or NL.

      • payment_method_options.customer_balance.bank_transfer.requested_address_types (array of enums, optional) List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.

        Permitted values include: sort_code, zengin, iban, or spei. Possible enum values:

        • aba aba bank account address type

        • iban iban bank account address type

        • sepa sepa bank account address type

        • sort_code sort_code bank account address type

        • spei spei bank account address type

        • swift swift bank account address type

        • zengin zengin bank account address type

    • payment_method_options.customer_balance.funding_type (enum, optional) The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer. Possible enum values:

      • bank_transfer

    • payment_method_options.customer_balance.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.demo_pay (object, optional) contains details about the DemoPay payment method options.

    • payment_method_options.demo_pay.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.eps (object, optional) contains details about the EPS payment method options.

    • payment_method_options.eps.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.fpx (object, optional) contains details about the FPX payment method options.

    • payment_method_options.fpx.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.giropay (object, optional) contains details about the Giropay payment method options.

    • payment_method_options.giropay.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.grabpay (object, optional) contains details about the Grabpay payment method options.

    • payment_method_options.grabpay.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.ideal (object, optional) contains details about the Ideal payment method options.

    • payment_method_options.ideal.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.kakao_pay (object, optional) contains details about the Kakao Pay payment method options.

    • payment_method_options.kakao_pay.capture_method (enum, optional) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.kakao_pay.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.klarna (object, optional) contains details about the Klarna payment method options.

    • payment_method_options.klarna.capture_method (enum, optional) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.klarna.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

    • payment_method_options.klarna.subscriptions (array of objects, optional) Subscription details if the Checkout Session sets up a future subscription.

      • payment_method_options.klarna.subscriptions.interval (enum, required) Unit of time between subscription charges.

      • payment_method_options.klarna.subscriptions.next_billing (object, required) Describes the upcoming charge for this subscription.

        • payment_method_options.klarna.subscriptions.next_billing.amount (integer, required) The amount of the next charge for the subscription.

        • payment_method_options.klarna.subscriptions.next_billing.date (string, required) The date of the next charge for the subscription in YYYY-MM-DD format.

      • payment_method_options.klarna.subscriptions.reference (string, required) A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.

      • payment_method_options.klarna.subscriptions.interval_count (integer, optional) The number of intervals (specified in the interval attribute) between subscription charges. For example, interval=month and interval_count=3 charges every 3 months.

      • payment_method_options.klarna.subscriptions.name (string, optional) Name for subscription.

  • payment_method_options.konbini (object, optional) contains details about the Konbini payment method options.

    • payment_method_options.konbini.expires_after_days (integer, optional) The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and expires_after_days set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days.

    • payment_method_options.konbini.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.kr_card (object, optional) contains details about the Korean card payment method options.

    • payment_method_options.kr_card.capture_method (enum, optional) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.kr_card.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.link (object, optional) contains details about the Link payment method options.

    • payment_method_options.link.capture_method (enum, optional) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.link.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.mobilepay (object, optional) contains details about the Mobilepay payment method options.

    • payment_method_options.mobilepay.capture_method (enum, optional) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.mobilepay.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.multibanco (object, optional) contains details about the Multibanco payment method options.

    • payment_method_options.multibanco.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.naver_pay (object, optional) contains details about the Naver Pay payment method options.

    • payment_method_options.naver_pay.capture_method (enum, optional) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.naver_pay.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.oxxo (object, optional) contains details about the OXXO payment method options.

    • payment_method_options.oxxo.expires_after_days (integer, optional) The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.

    • payment_method_options.oxxo.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.p24 (object, optional) contains details about the P24 payment method options.

    • payment_method_options.p24.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

    • payment_method_options.p24.tos_shown_and_accepted (boolean, optional) Confirm that the payer has accepted the P24 terms and conditions.

  • payment_method_options.pay_by_bank (object, optional) contains details about the Pay By Bank payment method options.

  • payment_method_options.payco (object, optional) contains details about the PAYCO payment method options.

    • payment_method_options.payco.capture_method (enum, optional) Controls when the funds will be captured from the customer’s account. Possible enum values:
      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

  • payment_method_options.paynow (object, optional) contains details about the PayNow payment method options.

    • payment_method_options.paynow.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.paypal (object, optional) contains details about the PayPal payment method options.

    • payment_method_options.paypal.capture_method (enum, optional) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.paypal.preferred_locale (enum, optional) Preferred locale of the PayPal checkout page that the customer is redirected to. Possible enum values:

      • cs-CZ Czech - The Czech Republic

      • da-DK Danish - Denmark

      • de-AT German - Austria

      • de-DE German - Germany

      • de-LU German - Luxembourg

      • el-GR Greek - Greece

      • en-GB English - United Kingdom

      • en-US English - United States of America

      • es-ES Spanish - Spain

      • fi-FI Finnish - Finland

      • fr-BE French - Belgium

      • fr-FR French - France

      • fr-LU French - Luxembourg

      • hu-HU Hungarian - Hungary

      • it-IT Italian - Italy

      • nl-BE Dutch - Belgium

      • nl-NL Dutch - Netherlands

      • pl-PL Polish - Poland

      • pt-PT Portuguese - Portugal

      • sk-SK Slovak - Slovakia

      • sv-SE Swedish - Sweden

    • payment_method_options.paypal.reference (string, optional) A reference of the PayPal transaction visible to customer which is mapped to PayPal’s invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.

    • payment_method_options.paypal.risk_correlation_id (string, optional) The risk correlation ID for an on-session payment using a saved PayPal payment method.

    • payment_method_options.paypal.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

      If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.pix (object, optional) contains details about the Pix payment method options.

    • payment_method_options.pix.amount_includes_iof (enum, optional) Determines if the amount includes the IOF tax. Defaults to never. Possible enum values:

      • always The IOF tax is included in the amount.

      • never The IOF tax is not included in the amount.

    • payment_method_options.pix.expires_after_seconds (integer, optional) The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.

    • payment_method_options.pix.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.revolut_pay (object, optional) contains details about the RevolutPay payment method options.

    • payment_method_options.revolut_pay.capture_method (enum, optional) Controls when the funds will be captured from the customer’s account. Possible enum values:

      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

    • payment_method_options.revolut_pay.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

  • payment_method_options.samsung_pay (object, optional) contains details about the Samsung Pay payment method options.

    • payment_method_options.samsung_pay.capture_method (enum, optional) Controls when the funds will be captured from the customer’s account. Possible enum values:
      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

  • payment_method_options.satispay (object, optional) contains details about the Satispay payment method options.

    • payment_method_options.satispay.capture_method (enum, optional) Controls when the funds will be captured from the customer’s account. Possible enum values:
      • manual Use manual if you intend to place the funds on hold and want to override the top-level capture_method value for this payment method.

  • payment_method_options.sepa_debit (object, optional) contains details about the Sepa Debit payment method options.

    • payment_method_options.sepa_debit.mandate_options (object, optional) Additional fields for Mandate creation

      • payment_method_options.sepa_debit.mandate_options.reference_prefix (string, optional) Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: ‘/’, ‘_’, ‘-’, ‘&’, ‘.’. Cannot begin with ‘STRIPE’.

    • payment_method_options.sepa_debit.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

      • on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

    • payment_method_options.sepa_debit.target_date (string, optional) Controls when Stripe will attempt to debit the funds from the customer’s account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.

  • payment_method_options.sofort (object, optional) contains details about the Sofort payment method options.

    • payment_method_options.sofort.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.swish (object, optional) contains details about the Swish payment method options.

    • payment_method_options.swish.reference (string, optional) The order reference that will be displayed to customers in the Swish application. Defaults to the id of the Payment Intent.

  • payment_method_options.twint (object, optional) contains details about the TWINT payment method options.

    • payment_method_options.twint.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

  • payment_method_options.us_bank_account (object, optional) contains details about the Us Bank Account payment method options.

    • payment_method_options.us_bank_account.financial_connections (object, optional) Additional fields for Financial Connections Session creation

      • payment_method_options.us_bank_account.financial_connections.permissions (array of strings, optional) The list of permissions to request. If this parameter is passed, the payment_method permission must be included. Valid permissions include: balances, ownership, payment_method, and transactions.

      • payment_method_options.us_bank_account.financial_connections.prefetch (array of enums, optional) List of data features that you would like to retrieve upon account creation. Possible enum values:

        • balances Requests to prefetch balance data on accounts collected in this session.

        • ownership Requests to prefetch ownership data on accounts collected in this session.

        • transactions Requests to prefetch transaction data on accounts collected in this session.

    • payment_method_options.us_bank_account.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

      • off_session Use off_session if your customer may or may not be present in your checkout flow.

      • on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

    • payment_method_options.us_bank_account.target_date (string, optional) Controls when Stripe will attempt to debit the funds from the customer’s account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.

    • payment_method_options.us_bank_account.verification_method (enum, optional) Verification method for the intent Possible enum values:

      • automatic Instant verification with fallback to microdeposits.

      • instant Instant verification only.

  • payment_method_options.wechat_pay (object, optional) contains details about the WeChat Pay payment method options.

    • payment_method_options.wechat_pay.client (enum, required) The client type that the end customer will pay from Possible enum values:

      • android The end customer will pay from an Android app

      • ios The end customer will pay from an iOS app

      • web The end customer will pay from web browser

    • payment_method_options.wechat_pay.app_id (string, optional) The app ID registered with WeChat Pay. Only required when client is ios or android.

    • payment_method_options.wechat_pay.setup_future_usage (enum, optional) Indicates that you intend to make future payments with this PaymentIntent’s payment method.

      If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

      If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

      When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA. Possible enum values:

      • none Use none if you do not intend to reuse this payment method and want to override the top-level setup_future_usage value for this payment method.

• payment_method_types (array of enums, 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. See Dynamic Payment Methods for more details.

  Read more about the supported payment methods and their requirements in our payment method details guide.

  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.

• permissions (object, optional) 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.

  • permissions.update_shipping_details (enum, optional) Determines which entity is allowed to update the shipping details.

    Default is client_only. Stripe Checkout client will automatically update the shipping details. If set to server_only, only your server is allowed to update the shipping details.

    When set to server_only, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API. Possible enum values:

    • client_only The field of the CheckoutSession can only be updated by the client via the publishable key.

    • server_only The field of the CheckoutSession can only be updated by the server via the secret key.

• 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.

  • phone_number_collection.enabled (boolean, required) Set to true to enable phone number collection.

    Can only be set in payment and subscription mode.

• redirect_on_completion (enum, optional) This parameter applies to ui_mode: embedded. Learn more about the redirect behavior of embedded sessions. Defaults to always. Possible enum values:

  • always The Session will always redirect to the return_url after successful confirmation.

  • if_required The Session will only redirect to the return_url after a redirect-based payment method is used.

  • never The Session will never redirect to the return_url, and redirect-based payment methods will be disabled.

• return_url (string, required conditionally) 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 or custom and redirect-based payment methods are enabled on the session.

• saved_payment_method_options (object, optional) Controls saved payment method settings for the session. Only available in payment and subscription mode.

  • saved_payment_method_options.allow_redisplay_filters (array of enums, optional) Uses the allow_redisplay value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout. Possible enum values:

    • always Use always to indicate that this payment method can always be shown to a customer in a checkout flow.

    • limited Use limited to indicate that this payment method can’t always be shown to a customer in a checkout flow. For example, it can only be shown in the context of a specific subscription.

    • unspecified This is the default value for payment methods where allow_redisplay wasn’t set.

  • saved_payment_method_options.payment_method_remove (enum, optional) Enable customers to choose if they wish to remove their saved payment methods. Disabled by default. Possible enum values:

    • disabled Removing payment methods will be disabled for this Checkout Session. This is the default option.

    • enabled Removing payment methods will be enabled for this Checkout Session.

  • saved_payment_method_options.payment_method_save (enum, optional) Enable customers to choose if they wish to save their payment method for future use. Disabled by default. Possible enum values:

    • disabled Saving payment methods will be disabled for this Checkout Session. This is the default option.

    • enabled Saving payment methods will be enabled for this Checkout Session.

• setup_intent_data (object, optional) A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in setup mode.

  • setup_intent_data.description (string, optional) An arbitrary string attached to the object. Often useful for displaying to users.

  • setup_intent_data.metadata (object, optional) Set of key-value pairs 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.

  • setup_intent_data.on_behalf_of (string, optional) The Stripe account for which the setup is intended.

• shipping_address_collection (object, optional) When set, provides configuration for Checkout to collect a shipping address from a customer.

  • shipping_address_collection.allowed_countries (array of enums, required) An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Possible enum values:
    • 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

• shipping_options (array of objects, optional) The shipping rate options to apply to this Session. Up to a maximum of 5.

  • shipping_options.shipping_rate (string, required unless shipping_rate_data is provided) The ID of the Shipping Rate to use for this shipping option.

  • shipping_options.shipping_rate_data (object, required unless shipping_rate is provided) Parameters to be passed to Shipping Rate creation for this shipping option.

    • shipping_options.shipping_rate_data.display_name (string, required) The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.

    • shipping_options.shipping_rate_data.delivery_estimate (object, optional) The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.

      • shipping_options.shipping_rate_data.delivery_estimate.maximum (object, optional) The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.

        • shipping_options.shipping_rate_data.delivery_estimate.maximum.unit (enum, required) A unit of time. Possible enum values:

          • business_day The delivery estimate is in business days.

          • day The delivery estimate is in days.

          • hour The delivery estimate is in hours.

          • month The delivery estimate is in months.

          • week The delivery estimate is in weeks.

        • shipping_options.shipping_rate_data.delivery_estimate.maximum.value (integer, required) Must be greater than 0.

      • shipping_options.shipping_rate_data.delivery_estimate.minimum (object, optional) The lower bound of the estimated range. If empty, represents no lower bound.

        • shipping_options.shipping_rate_data.delivery_estimate.minimum.unit (enum, required) A unit of time. Possible enum values:

          • business_day The delivery estimate is in business days.

          • day The delivery estimate is in days.

          • hour The delivery estimate is in hours.

          • month The delivery estimate is in months.

          • week The delivery estimate is in weeks.

        • shipping_options.shipping_rate_data.delivery_estimate.minimum.value (integer, required) Must be greater than 0.

    • shipping_options.shipping_rate_data.fixed_amount (object, optional) Describes a fixed amount to charge for shipping. Must be present if type is fixed_amount.

      • shipping_options.shipping_rate_data.fixed_amount.amount (integer, required) A non-negative integer in cents representing how much to charge.

      • shipping_options.shipping_rate_data.fixed_amount.currency (enum, required) Three-letter ISO currency code, in lowercase. Must be a supported currency.

      • shipping_options.shipping_rate_data.fixed_amount.currency_options (object, optional) Shipping rates defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.

        • shipping_options.shipping_rate_data.fixed_amount.currency_options.<currency>.amount (integer, required) A non-negative integer in cents representing how much to charge.

        • shipping_options.shipping_rate_data.fixed_amount.currency_options.<currency>.tax_behavior (enum, recommended if calculating taxes) Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Possible enum values:

          • exclusive
          • inclusive
          • unspecified

    • shipping_options.shipping_rate_data.metadata (object, optional) Set of key-value pairs 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.

    • shipping_options.shipping_rate_data.tax_behavior (enum, recommended if calculating taxes) Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Possible enum values:

      • exclusive
      • inclusive
      • unspecified

    • shipping_options.shipping_rate_data.tax_code (string, recommended if calculating taxes) A tax code ID. The Shipping tax code is txcd_92010001.

    • shipping_options.shipping_rate_data.type (enum, required) The type of calculation to use on the shipping rate. Possible enum values:

      • fixed_amount The shipping rate is a fixed amount.

• submit_type (enum, 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. Possible enum values:

  • auto pay will used for payment mode sessions and subscribe will be used for subscription mode sessions

  • book Recommended when offering bookings. Submit button includes a ‘Book’ label

  • donate Recommended when accepting donations. Submit button includes a ‘Donate’ label

  • pay Submit button includes a ‘Buy’ label

  • subscribe Submit button includes a ‘Subscribe’ label

• subscription_data (object, optional) A subset of parameters to be passed to subscription creation for Checkout Sessions in subscription mode.

  • subscription_data.application_fee_percent (float, optional) A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner’s Stripe account. To use an application fee percent, the request must be made on behalf of another account, using the Stripe-Account header or an OAuth key. For more information, see the application fees documentation.

  • subscription_data.billing_cycle_anchor (timestamp, optional) A future timestamp to anchor the subscription’s billing cycle for new subscriptions.

  • subscription_data.billing_mode (object, optional) Controls how prorations and invoices for subscriptions are calculated and orchestrated.

    • subscription_data.billing_mode.type (enum, required) Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is flexible. Possible enum values:

      • classic Calculations for subscriptions and invoices are based on legacy defaults.

      • flexible Supports more flexible calculation and orchestration options for subscriptions and invoices.

    • subscription_data.billing_mode.flexible (object, optional) Configure behavior for flexible billing mode.

      • subscription_data.billing_mode.flexible.proration_discounts (enum, optional) Controls how invoices and invoice items display proration amounts and discount amounts. Possible enum values:

        • included Amounts are net of discounts, and discount amounts are zero.

        • itemized Amounts are gross of discounts, and discount amounts are accurate.

  • subscription_data.default_tax_rates (array of strings, optional) The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.

  • subscription_data.description (string, optional) The subscription’s description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in the customer portal.

  • subscription_data.invoice_settings (object, optional) All invoices will be billed using the specified settings.

    • subscription_data.invoice_settings.issuer (object, optional) The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.

      • subscription_data.invoice_settings.issuer.type (enum, required) Type of the account referenced in the request. Possible enum values:

        • account Indicates that the account being referenced is a connected account which is different from the account making the API request but related to it.

        • self Indicates that the account being referenced is the account making the API request.

      • subscription_data.invoice_settings.issuer.account (string, required only if type is account) The connected account being referenced when type is account.

  • subscription_data.metadata (object, optional) Set of key-value pairs 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.

  • subscription_data.on_behalf_of (string, optional) The account on behalf of which to charge, for each of the subscription’s invoices.

  • subscription_data.proration_behavior (enum, optional) Determines how to handle prorations resulting from the billing_cycle_anchor. If no value is passed, the default is create_prorations. Possible enum values:

    • create_prorations Will cause proration invoice items to be created when applicable.

    • none Disable creating prorations in current Checkout Session

  • subscription_data.transfer_data (object, optional) If specified, the funds from the subscription’s invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.

    • subscription_data.transfer_data.destination (string, required) ID of an existing, connected Stripe account.

    • subscription_data.transfer_data.amount_percent (float, optional) A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.

  • subscription_data.trial_end (integer, optional) Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48 hours in the future.

  • subscription_data.trial_period_days (integer, optional) Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.

  • subscription_data.trial_settings (object, optional) Settings related to subscription trials.

    • subscription_data.trial_settings.end_behavior (object, required) Defines how the subscription should behave when the user’s free trial ends.

      • subscription_data.trial_settings.end_behavior.missing_payment_method (enum, required) Indicates how the subscription should change when the trial ends if the user did not provide a payment method. Possible enum values:

        • cancel Cancel the subscription if a payment method is not attached when the trial ends.

        • create_invoice Create an invoice when the trial ends, even if the user did not set up a payment method.

        • pause Pause the subscription if a payment method is not attached when the trial ends.

• success_url (string, required conditionally) The URL to which Stripe should send customers when payment or setup is complete. This parameter is not allowed if ui_mode is embedded or custom. If you’d like to use information from the successful Checkout Session on your page, read the guide on customizing your success page.

• tax_id_collection (object, optional) Controls tax ID collection during checkout.

  • tax_id_collection.enabled (boolean, required) Enable tax ID collection during checkout. Defaults to false.

  • tax_id_collection.required (enum, optional) Describes whether a tax ID is required during checkout. Defaults to never. Possible enum values:

    • if_supported A tax ID will be required if collection is supported for the selected billing address country.

    • never Tax ID collection is never required.

• ui_mode (enum, optional) The UI mode of the Session. Defaults to hosted. Possible enum values:

  • custom The Checkout Session will be displayed using embedded components on your website

  • embedded The Checkout Session will be displayed as an embedded form on your website.

  • hosted The Checkout Session will be displayed on a hosted page that customers will be redirected to.

• wallet_options (object, optional) Wallet-specific configuration.

  • wallet_options.link (object, optional) contains details about the Link wallet options.

    • wallet_options.link.display (enum, optional) Specifies whether Checkout should display Link as a payment option. By default, Checkout will display all the supported wallets that the Checkout Session was created with. This is the auto behavior, and it is the default choice. Possible enum values:

      • auto The Checkout Session will automatically determine if Link is a supported payment option and display accordingly.

      • never The Checkout Session will not display Link as a payment option.

curl https://api.stripe.com/v1/checkout/sessions \
  -u "<<YOUR_SECRET_KEY>>
  --data-urlencode success_url="https://example.com/success" \
  -d "line_items[0][price]"=price_1MotwRLkdIwHu7ixYcPLm5uZ \
  -d "line_items[0][quantity]"=2 \
  -d mode=payment

stripe checkout sessions create  \
  --success-url="https://example.com/success" \
  -d "line_items[0][price]"=price_1MotwRLkdIwHu7ixYcPLm5uZ \
  -d "line_items[0][quantity]"=2 \
  --mode=payment

client = Stripe::StripeClient.new("<<YOUR_SECRET_KEY>>

session = client.v1.checkout.sessions.create({
  success_url: 'https://example.com/success',
  line_items: [
    {
      price: 'price_1MotwRLkdIwHu7ixYcPLm5uZ',
      quantity: 2,
    },
  ],
  mode: 'payment',
})

client = StripeClient("<<YOUR_SECRET_KEY>>

session = client.v1.checkout.sessions.create({
  "success_url": "https://example.com/success",
  "line_items": [{"price": "price_1MotwRLkdIwHu7ixYcPLm5uZ", "quantity": 2}],
  "mode": "payment",
})

$stripe = new \Stripe\StripeClient('<<YOUR_SECRET_KEY>>

$session = $stripe->checkout->sessions->create([
  'success_url' => 'https://example.com/success',
  'line_items' => [
    [
      'price' => 'price_1MotwRLkdIwHu7ixYcPLm5uZ',
      'quantity' => 2,
    ],
  ],
  'mode' => 'payment',
]);

StripeClient client = new StripeClient("<<YOUR_SECRET_KEY>>

SessionCreateParams params =
  SessionCreateParams.builder()
    .setSuccessUrl("https://example.com/success")
    .addLineItem(
      SessionCreateParams.LineItem.builder()
        .setPrice("price_1MotwRLkdIwHu7ixYcPLm5uZ")
        .setQuantity(2L)
        .build()
    )
    .setMode(SessionCreateParams.Mode.PAYMENT)
    .build();

Session session = client.v1().checkout().sessions().create(params);

const stripe = require('stripe')('<<YOUR_SECRET_KEY>>

const session = await stripe.checkout.sessions.create({
  success_url: 'https://example.com/success',
  line_items: [
    {
      price: 'price_1MotwRLkdIwHu7ixYcPLm5uZ',
      quantity: 2,
    },
  ],
  mode: 'payment',
});

sc := stripe.NewClient("<<YOUR_SECRET_KEY>>
params := &stripe.CheckoutSessionCreateParams{
  SuccessURL: stripe.String("https://example.com/success"),
  LineItems: []*stripe.CheckoutSessionCreateLineItemParams{
    &stripe.CheckoutSessionCreateLineItemParams{
      Price: stripe.String("price_1MotwRLkdIwHu7ixYcPLm5uZ"),
      Quantity: stripe.Int64(2),
    },
  },
  Mode: stripe.String(stripe.CheckoutSessionModePayment),
}
result, err := sc.V1CheckoutSessions.Create(context.TODO(), params)

var options = new Stripe.Checkout.SessionCreateOptions
{
    SuccessUrl = "https://example.com/success",
    LineItems = new List<Stripe.Checkout.SessionLineItemOptions>
    {
        new Stripe.Checkout.SessionLineItemOptions
        {
            Price = "price_1MotwRLkdIwHu7ixYcPLm5uZ",
            Quantity = 2,
        },
    },
    Mode = "payment",
};
var client = new StripeClient("<<YOUR_SECRET_KEY>>
var service = client.V1.Checkout.Sessions;
Stripe.Checkout.Session session = service.Create(options);

Response

{
  "id": "cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u",
  "object": "checkout.session",
  "after_expiration": null,
  "allow_promotion_codes": null,
  "amount_subtotal": 2198,
  "amount_total": 2198,
  "automatic_tax": {
    "enabled": false,
    "liability": null,
    "status": null
  },
  "billing_address_collection": null,
  "cancel_url": null,
  "client_reference_id": null,
  "consent": null,
  "consent_collection": null,
  "created": 1679600215,
  "currency": "usd",
  "custom_fields": [],
  "custom_text": {
    "shipping_address": null,
    "submit": null
  },
  "customer": null,
  "customer_creation": "if_required",
  "customer_details": null,
  "customer_email": null,
  "expires_at": 1679686615,
  "invoice": null,
  "invoice_creation": {
    "enabled": false,
    "invoice_data": {
      "account_tax_ids": null,
      "custom_fields": null,
      "description": null,
      "footer": null,
      "issuer": null,
      "metadata": {},
      "rendering_options": null
    }
  },
  "livemode": false,
  "locale": null,
  "metadata": {},
  "mode": "payment",
  "payment_intent": null,
  "payment_link": null,
  "payment_method_collection": "always",
  "payment_method_options": {},
  "payment_method_types": [
    "card"
  ],
  "payment_status": "unpaid",
  "phone_number_collection": {
    "enabled": false
  },
  "recovered_from": null,
  "setup_intent": null,
  "shipping_address_collection": null,
  "shipping_cost": null,
  "shipping_details": null,
  "shipping_options": [],
  "status": "open",
  "submit_type": null,
  "subscription": null,
  "success_url": "https://example.com/success",
  "total_details": {
    "amount_discount": 0,
    "amount_shipping": 0,
    "amount_tax": 0
  },
  "url": "https://checkout.stripe.com/c/pay/cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u#fidkdWxOYHwnPyd1blpxYHZxWjA0SDdPUW5JbmFMck1wMmx9N2BLZjFEfGRUNWhqTmJ%2FM2F8bUA2SDRySkFdUV81T1BSV0YxcWJcTUJcYW5rSzN3dzBLPUE0TzRKTTxzNFBjPWZEX1NKSkxpNTVjRjN8VHE0YicpJ2N3amhWYHdzYHcnP3F3cGApJ2lkfGpwcVF8dWAnPyd2bGtiaWBabHFgaCcpJ2BrZGdpYFVpZGZgbWppYWB3dic%2FcXdwYHgl"
}

Update a Checkout Session

Updates a Checkout Session object.

Related guide: Dynamically update Checkout

Returns

Returns a Checkout Session object.

Parameters

• collected_information (object, optional) Information about the customer collected within the Checkout Session. Can only be set when updating embedded or custom sessions.

  • collected_information.shipping_details (object, optional) The shipping details to apply to this Session.

    • collected_information.shipping_details.address (object, required) The address of the customer

      • collected_information.shipping_details.address.country (string, required) Two-letter country code (ISO 3166-1 alpha-2).

      • collected_information.shipping_details.address.line1 (string, required) Address line 1, such as the street, PO Box, or company name.

      • collected_information.shipping_details.address.city (string, optional) City, district, suburb, town, or village.

      • collected_information.shipping_details.address.line2 (string, optional) Address line 2, such as the apartment, suite, unit, or building.

      • collected_information.shipping_details.address.postal_code (string, optional) ZIP or postal code.

      • collected_information.shipping_details.address.state (string, optional) State, county, province, or region.

    • collected_information.shipping_details.name (string, required) The name of customer

• metadata (object, optional) Set of key-value pairs 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.

• shipping_options (array of objects, optional) The shipping rate options to apply to this Session. Up to a maximum of 5.

  • shipping_options.shipping_rate (string, required unless shipping_rate_data is provided) The ID of the Shipping Rate to use for this shipping option.

  • shipping_options.shipping_rate_data (object, required unless shipping_rate is provided) Parameters to be passed to Shipping Rate creation for this shipping option.

    • shipping_options.shipping_rate_data.display_name (string, required) The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.

    • shipping_options.shipping_rate_data.delivery_estimate (object, optional) The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.

      • shipping_options.shipping_rate_data.delivery_estimate.maximum (object, optional) The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.

        • shipping_options.shipping_rate_data.delivery_estimate.maximum.unit (enum, required) A unit of time. Possible enum values:

          • business_day The delivery estimate is in business days.

          • day The delivery estimate is in days.

          • hour The delivery estimate is in hours.

          • month The delivery estimate is in months.

          • week The delivery estimate is in weeks.

        • shipping_options.shipping_rate_data.delivery_estimate.maximum.value (integer, required) Must be greater than 0.

      • shipping_options.shipping_rate_data.delivery_estimate.minimum (object, optional) The lower bound of the estimated range. If empty, represents no lower bound.

        • shipping_options.shipping_rate_data.delivery_estimate.minimum.unit (enum, required) A unit of time. Possible enum values:

          • business_day The delivery estimate is in business days.

          • day The delivery estimate is in days.

          • hour The delivery estimate is in hours.

          • month The delivery estimate is in months.

          • week The delivery estimate is in weeks.

        • shipping_options.shipping_rate_data.delivery_estimate.minimum.value (integer, required) Must be greater than 0.

    • shipping_options.shipping_rate_data.fixed_amount (object, optional) Describes a fixed amount to charge for shipping. Must be present if type is fixed_amount.

      • shipping_options.shipping_rate_data.fixed_amount.amount (integer, required) A non-negative integer in cents representing how much to charge.

      • shipping_options.shipping_rate_data.fixed_amount.currency (enum, required) Three-letter ISO currency code, in lowercase. Must be a supported currency.

      • shipping_options.shipping_rate_data.fixed_amount.currency_options (object, optional) Shipping rates defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.

        • shipping_options.shipping_rate_data.fixed_amount.currency_options.<currency>.amount (integer, required) A non-negative integer in cents representing how much to charge.

        • shipping_options.shipping_rate_data.fixed_amount.currency_options.<currency>.tax_behavior (enum, recommended if calculating taxes) Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Possible enum values:

          • exclusive
          • inclusive
          • unspecified

    • shipping_options.shipping_rate_data.metadata (object, optional) Set of key-value pairs 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.

    • shipping_options.shipping_rate_data.tax_behavior (enum, recommended if calculating taxes) Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Possible enum values:

      • exclusive
      • inclusive
      • unspecified

    • shipping_options.shipping_rate_data.tax_code (string, recommended if calculating taxes) A tax code ID. The Shipping tax code is txcd_92010001.

    • shipping_options.shipping_rate_data.type (enum, required) The type of calculation to use on the shipping rate. Possible enum values:

      • fixed_amount The shipping rate is a fixed amount.

curl https://api.stripe.com/v1/checkout/sessions/cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u \
  -u "<<YOUR_SECRET_KEY>>
  -d "metadata[order_id]"=6735

stripe checkout sessions update cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u \
  -d "metadata[order_id]"=6735

client = Stripe::StripeClient.new("<<YOUR_SECRET_KEY>>

session = client.v1.checkout.sessions.update(
  'cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u',
  {metadata: {order_id: '6735'}},
)

client = StripeClient("<<YOUR_SECRET_KEY>>

session = client.v1.checkout.sessions.update(
  "cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u",
  {"metadata": {"order_id": "6735"}},
)

$stripe = new \Stripe\StripeClient('<<YOUR_SECRET_KEY>>

$session = $stripe->checkout->sessions->update(
  'cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u',
  ['metadata' => ['order_id' => '6735']]
);

StripeClient client = new StripeClient("<<YOUR_SECRET_KEY>>

SessionUpdateParams params =
  SessionUpdateParams.builder().putMetadata("order_id", "6735").build();

Session session =
  client.v1().checkout().sessions().update(
    "cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u",
    params
  );

const stripe = require('stripe')('<<YOUR_SECRET_KEY>>

const session = await stripe.checkout.sessions.update(
  'cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u',
  {
    metadata: {
      order_id: '6735',
    },
  }
);

sc := stripe.NewClient("<<YOUR_SECRET_KEY>>
params := &stripe.CheckoutSessionUpdateParams{
  Session: stripe.String("cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u"),
}
params.AddMetadata("order_id", "6735")
result, err := sc.V1CheckoutSessions.Update(context.TODO(), params)

var options = new Stripe.Checkout.SessionUpdateOptions
{
    Metadata = new Dictionary<string, string> { { "order_id", "6735" } },
};
var client = new StripeClient("<<YOUR_SECRET_KEY>>
var service = client.V1.Checkout.Sessions;
Stripe.Checkout.Session session = service.Update(
    "cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u",
    options);

Response

{
  "id": "cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u",
  "object": "checkout.session",
  "after_expiration": null,
  "allow_promotion_codes": null,
  "amount_subtotal": 2198,
  "amount_total": 2198,
  "automatic_tax": {
    "enabled": false,
    "liability": null,
    "status": null
  },
  "billing_address_collection": null,
  "cancel_url": null,
  "client_reference_id": null,
  "consent": null,
  "consent_collection": null,
  "created": 1679600215,
  "currency": "usd",
  "custom_fields": [],
  "custom_text": {
    "shipping_address": null,
    "submit": null
  },
  "customer": null,
  "customer_creation": "if_required",
  "customer_details": null,
  "customer_email": null,
  "expires_at": 1679686615,
  "invoice": null,
  "invoice_creation": {
    "enabled": false,
    "invoice_data": {
      "account_tax_ids": null,
      "custom_fields": null,
      "description": null,
      "footer": null,
      "issuer": null,
      "metadata": {},
      "rendering_options": null
    }
  },
  "livemode": false,
  "locale": null,
  "metadata": {
    "order_id": "6735"
  },
  "mode": "payment",
  "payment_intent": null,
  "payment_link": null,
  "payment_method_collection": "always",
  "payment_method_options": {},
  "payment_method_types": [
    "card"
  ],
  "payment_status": "unpaid",
  "phone_number_collection": {
    "enabled": false
  },
  "recovered_from": null,
  "setup_intent": null,
  "shipping_address_collection": null,
  "shipping_cost": null,
  "shipping_details": null,
  "shipping_options": [],
  "status": "open",
  "submit_type": null,
  "subscription": null,
  "success_url": "https://example.com/success",
  "total_details": {
    "amount_discount": 0,
    "amount_shipping": 0,
    "amount_tax": 0
  },
  "url": "https://checkout.stripe.com/c/pay/cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u#fidkdWxOYHwnPyd1blpxYHZxWjA0SDdPUW5JbmFMck1wMmx9N2BLZjFEfGRUNWhqTmJ%2FM2F8bUA2SDRySkFdUV81T1BSV0YxcWJcTUJcYW5rSzN3dzBLPUE0TzRKTTxzNFBjPWZEX1NKSkxpNTVjRjN8VHE0YicpJ2N3amhWYHdzYHcnP3F3cGApJ2lkfGpwcVF8dWAnPyd2bGtiaWBabHFgaCcpJ2BrZGdpYFVpZGZgbWppYWB3dic%2FcXdwYHgl"
}

Retrieve a Checkout Session

Retrieves a Checkout Session object.

Returns

Returns a Checkout Session object.

curl https://api.stripe.com/v1/checkout/sessions/cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u \
  -u "<<YOUR_SECRET_KEY>>

stripe checkout sessions retrieve cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u

client = Stripe::StripeClient.new("<<YOUR_SECRET_KEY>>

session = client.v1.checkout.sessions.retrieve('cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u')

client = StripeClient("<<YOUR_SECRET_KEY>>

session = client.v1.checkout.sessions.retrieve(
  "cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u",
)

$stripe = new \Stripe\StripeClient('<<YOUR_SECRET_KEY>>

$session = $stripe->checkout->sessions->retrieve(
  'cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u',
  []
);

StripeClient client = new StripeClient("<<YOUR_SECRET_KEY>>

SessionRetrieveParams params = SessionRetrieveParams.builder().build();

Session session =
  client.v1().checkout().sessions().retrieve(
    "cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u",
    params
  );

const stripe = require('stripe')('<<YOUR_SECRET_KEY>>

const session = await stripe.checkout.sessions.retrieve(
  'cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u'
);

sc := stripe.NewClient("<<YOUR_SECRET_KEY>>
params := &stripe.CheckoutSessionRetrieveParams{
  Session: stripe.String("cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u"),
}
result, err := sc.V1CheckoutSessions.Retrieve(context.TODO(), params)

var client = new StripeClient("<<YOUR_SECRET_KEY>>
var service = client.V1.Checkout.Sessions;
Stripe.Checkout.Session session = service.Get(
    "cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u");

Response

{
  "id": "cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u",
  "object": "checkout.session",
  "after_expiration": null,
  "allow_promotion_codes": null,
  "amount_subtotal": 2198,
  "amount_total": 2198,
  "automatic_tax": {
    "enabled": false,
    "liability": null,
    "status": null
  },
  "billing_address_collection": null,
  "cancel_url": null,
  "client_reference_id": null,
  "consent": null,
  "consent_collection": null,
  "created": 1679600215,
  "currency": "usd",
  "custom_fields": [],
  "custom_text": {
    "shipping_address": null,
    "submit": null
  },
  "customer": null,
  "customer_creation": "if_required",
  "customer_details": null,
  "customer_email": null,
  "expires_at": 1679686615,
  "invoice": null,
  "invoice_creation": {
    "enabled": false,
    "invoice_data": {
      "account_tax_ids": null,
      "custom_fields": null,
      "description": null,
      "footer": null,
      "issuer": null,
      "metadata": {},
      "rendering_options": null
    }
  },
  "livemode": false,
  "locale": null,
  "metadata": {},
  "mode": "payment",
  "payment_intent": null,
  "payment_link": null,
  "payment_method_collection": "always",
  "payment_method_options": {},
  "payment_method_types": [
    "card"
  ],
  "payment_status": "unpaid",
  "phone_number_collection": {
    "enabled": false
  },
  "recovered_from": null,
  "setup_intent": null,
  "shipping_address_collection": null,
  "shipping_cost": null,
  "shipping_details": null,
  "shipping_options": [],
  "status": "open",
  "submit_type": null,
  "subscription": null,
  "success_url": "https://example.com/success",
  "total_details": {
    "amount_discount": 0,
    "amount_shipping": 0,
    "amount_tax": 0
  },
  "url": "https://checkout.stripe.com/c/pay/cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u#fidkdWxOYHwnPyd1blpxYHZxWjA0SDdPUW5JbmFMck1wMmx9N2BLZjFEfGRUNWhqTmJ%2FM2F8bUA2SDRySkFdUV81T1BSV0YxcWJcTUJcYW5rSzN3dzBLPUE0TzRKTTxzNFBjPWZEX1NKSkxpNTVjRjN8VHE0YicpJ2N3amhWYHdzYHcnP3F3cGApJ2lkfGpwcVF8dWAnPyd2bGtiaWBabHFgaCcpJ2BrZGdpYFVpZGZgbWppYWB3dic%2FcXdwYHgl"
}

Retrieve a Checkout Session's line items

When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

Returns

A dictionary with a data property that contains an array of up to limit Checkout Session line items, starting after Line Item starting_after. Each entry in the array is a separate Line Item object. If no more line items are available, the resulting array will be empty.

Parameters

• ending_before (string, optional) A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

• limit (integer, optional) A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

• starting_after (string, optional) A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

curl https://api.stripe.com/v1/checkout/sessions/cs_test_a1enSAC01IA3Ps2vL32mNoWKMCNmmfUGTeEeHXI5tLCvyFNGsdG2UNA7mr/line_items \
  -u "<<YOUR_SECRET_KEY>>

stripe checkout sessions list_line_items cs_test_a1enSAC01IA3Ps2vL32mNoWKMCNmmfUGTeEeHXI5tLCvyFNGsdG2UNA7mr

client = Stripe::StripeClient.new("<<YOUR_SECRET_KEY>>

line_items = client.v1.checkout.sessions.line_items.list('cs_test_a1enSAC01IA3Ps2vL32mNoWKMCNmmfUGTeEeHXI5tLCvyFNGsdG2UNA7mr')

client = StripeClient("<<YOUR_SECRET_KEY>>

line_items = client.v1.checkout.sessions.line_items.list(
  "cs_test_a1enSAC01IA3Ps2vL32mNoWKMCNmmfUGTeEeHXI5tLCvyFNGsdG2UNA7mr",
)

$stripe = new \Stripe\StripeClient('<<YOUR_SECRET_KEY>>

$lineItems = $stripe->checkout->sessions->allLineItems(
  'cs_test_a1enSAC01IA3Ps2vL32mNoWKMCNmmfUGTeEeHXI5tLCvyFNGsdG2UNA7mr',
  []
);

StripeClient client = new StripeClient("<<YOUR_SECRET_KEY>>

SessionLineItemListParams params = SessionLineItemListParams.builder().build();

StripeCollection<LineItem> stripeCollection =
  client.v1().checkout().sessions().lineItems().list(
    "cs_test_a1enSAC01IA3Ps2vL32mNoWKMCNmmfUGTeEeHXI5tLCvyFNGsdG2UNA7mr",
    params
  );

const stripe = require('stripe')('<<YOUR_SECRET_KEY>>

const lineItems = await stripe.checkout.sessions.listLineItems(
  'cs_test_a1enSAC01IA3Ps2vL32mNoWKMCNmmfUGTeEeHXI5tLCvyFNGsdG2UNA7mr'
);

sc := stripe.NewClient("<<YOUR_SECRET_KEY>>
params := &stripe.CheckoutSessionListLineItemsParams{
  Session: stripe.String("cs_test_a1enSAC01IA3Ps2vL32mNoWKMCNmmfUGTeEeHXI5tLCvyFNGsdG2UNA7mr"),
}
result := sc.V1CheckoutSessions.ListLineItems(context.TODO(), params)

var client = new StripeClient("<<YOUR_SECRET_KEY>>
var service = client.V1.Checkout.Sessions.LineItems;
StripeList<LineItem> lineItems = service.List(
    "cs_test_a1enSAC01IA3Ps2vL32mNoWKMCNmmfUGTeEeHXI5tLCvyFNGsdG2UNA7mr");

Response

{
  "object": "list",
  "data": [
    {
      "id": "li_1N4BEoLkdIwHu7ixWtXug1yk",
      "object": "item",
      "amount_discount": 0,
      "amount_subtotal": 2198,
      "amount_tax": 0,
      "amount_total": 2198,
      "currency": "usd",
      "description": "T-shirt",
      "price": {
        "id": "price_1N4AEsLkdIwHu7ix7Ssho8Cl",
        "object": "price",
        "active": true,
        "billing_scheme": "per_unit",
        "created": 1683237782,
        "currency": "usd",
        "custom_unit_amount": null,
        "livemode": false,
        "lookup_key": null,
        "metadata": {},
        "nickname": null,
        "product": "prod_NppuJWzzNnD5Ut",
        "recurring": null,
        "tax_behavior": "unspecified",
        "tiers_mode": null,
        "transform_quantity": null,
        "type": "one_time",
        "unit_amount": 1099,
        "unit_amount_decimal": "1099"
      },
      "quantity": 2
    }
  ],
  "has_more": false,
  "url": "/v1/checkout/sessions/cs_test_a1enSAC01IA3Ps2vL32mNoWKMCNmmfUGTeEeHXI5tLCvyFNGsdG2UNA7mr/line_items"
}

List all Checkout Sessions

Returns a list of Checkout Sessions.

Returns

A dictionary with a data property that contains an array of up to limit Checkout Sessions, starting after Checkout Session starting_after. Each entry in the array is a separate Checkout Session object. If no more Checkout Sessions are available, the resulting array will be empty.

Parameters

• created (object, optional) Only return Checkout Sessions that were created during the given date interval.

  • created.gt (integer, optional) Minimum value to filter by (exclusive)

  • created.gte (integer, optional) Minimum value to filter by (inclusive)

  • created.lt (integer, optional) Maximum value to filter by (exclusive)

  • created.lte (integer, optional) Maximum value to filter by (inclusive)

• customer (string, optional) Only return the Checkout Sessions for the Customer specified.

• customer_details (object, optional) Only return the Checkout Sessions for the Customer details specified.

  • customer_details.email (string, required) Customer’s email address.

• ending_before (string, optional) A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

• limit (integer, optional) A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

• payment_intent (string, optional) Only return the Checkout Session for the PaymentIntent specified.

• payment_link (string, optional) Only return the Checkout Sessions for the Payment Link specified.

• starting_after (string, optional) A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

• status (enum, optional) Only return the Checkout Sessions matching the given status. Possible enum values:

  • complete The checkout session is complete. Payment processing may still be in progress

  • expired The checkout session has expired. No further processing will occur

  • open The checkout session is still in progress. Payment processing has not started

• subscription (string, optional) Only return the Checkout Session for the subscription specified.

curl -G https://api.stripe.com/v1/checkout/sessions \
  -u "<<YOUR_SECRET_KEY>>
  -d limit=3

stripe checkout sessions list  \
  --limit=3

client = Stripe::StripeClient.new("<<YOUR_SECRET_KEY>>

sessions = client.v1.checkout.sessions.list({limit: 3})

client = StripeClient("<<YOUR_SECRET_KEY>>

sessions = client.v1.checkout.sessions.list({"limit": 3})

$stripe = new \Stripe\StripeClient('<<YOUR_SECRET_KEY>>

$sessions = $stripe->checkout->sessions->all(['limit' => 3]);

StripeClient client = new StripeClient("<<YOUR_SECRET_KEY>>

SessionListParams params = SessionListParams.builder().setLimit(3L).build();

StripeCollection<Session> stripeCollection =
  client.v1().checkout().sessions().list(params);

const stripe = require('stripe')('<<YOUR_SECRET_KEY>>

const sessions = await stripe.checkout.sessions.list({
  limit: 3,
});

sc := stripe.NewClient("<<YOUR_SECRET_KEY>>
params := &stripe.CheckoutSessionListParams{}
params.Limit = stripe.Int64(3)
result := sc.V1CheckoutSessions.List(context.TODO(), params)

var options = new Stripe.Checkout.SessionListOptions { Limit = 3 };
var client = new StripeClient("<<YOUR_SECRET_KEY>>
var service = client.V1.Checkout.Sessions;
StripeList<Stripe.Checkout.Session> sessions = service.List(options);

Response

{
  "object": "list",
  "url": "/v1/checkout/sessions",
  "has_more": false,
  "data": [
    {
      "id": "cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u",
      "object": "checkout.session",
      "after_expiration": null,
      "allow_promotion_codes": null,
      "amount_subtotal": 2198,
      "amount_total": 2198,
      "automatic_tax": {
        "enabled": false,
        "liability": null,
        "status": null
      },
      "billing_address_collection": null,
      "cancel_url": null,
      "client_reference_id": null,
      "consent": null,
      "consent_collection": null,
      "created": 1679600215,
      "currency": "usd",
      "custom_fields": [],
      "custom_text": {
        "shipping_address": null,
        "submit": null
      },
      "customer": null,
      "customer_creation": "if_required",
      "customer_details": null,
      "customer_email": null,
      "expires_at": 1679686615,
      "invoice": null,
      "invoice_creation": {
        "enabled": false,
        "invoice_data": {
          "account_tax_ids": null,
          "custom_fields": null,
          "description": null,
          "footer": null,
          "issuer": null,
          "metadata": {},
          "rendering_options": null
        }
      },
      "livemode": false,
      "locale": null,
      "metadata": {},
      "mode": "payment",
      "payment_intent": null,
      "payment_link": null,
      "payment_method_collection": "always",
      "payment_method_options": {},
      "payment_method_types": [
        "card"
      ],
      "payment_status": "unpaid",
      "phone_number_collection": {
        "enabled": false
      },
      "recovered_from": null,
      "setup_intent": null,
      "shipping_address_collection": null,
      "shipping_cost": null,
      "shipping_details": null,
      "shipping_options": [],
      "status": "open",
      "submit_type": null,
      "subscription": null,
      "success_url": "https://example.com/success",
      "total_details": {
        "amount_discount": 0,
        "amount_shipping": 0,
        "amount_tax": 0
      },
      "url": "https://checkout.stripe.com/c/pay/cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u#fidkdWxOYHwnPyd1blpxYHZxWjA0SDdPUW5JbmFMck1wMmx9N2BLZjFEfGRUNWhqTmJ%2FM2F8bUA2SDRySkFdUV81T1BSV0YxcWJcTUJcYW5rSzN3dzBLPUE0TzRKTTxzNFBjPWZEX1NKSkxpNTVjRjN8VHE0YicpJ2N3amhWYHdzYHcnP3F3cGApJ2lkfGpwcVF8dWAnPyd2bGtiaWBabHFgaCcpJ2BrZGdpYFVpZGZgbWppYWB3dic%2FcXdwYHgl"
    }
  ]
}

Expire a Checkout Session

A Checkout Session can be expired when it is in one of these statuses: open

After it expires, a customer can’t complete a Checkout Session and customers loading the Checkout Session see a message saying the Checkout Session is expired.

Returns

Returns a Checkout Session object if the expiration succeeded. Returns an error if the Checkout Session has already expired or isn’t in an expireable state.

curl -X POST https://api.stripe.com/v1/checkout/sessions/cs_test_a1Ae6ClgOkjygKwrf9B3L6ITtUuZW4Xx9FivL6DZYoYFdfAefQxsYpJJd3/expire \
  -u "<<YOUR_SECRET_KEY>>

stripe checkout sessions expire cs_test_a1Ae6ClgOkjygKwrf9B3L6ITtUuZW4Xx9FivL6DZYoYFdfAefQxsYpJJd3

client = Stripe::StripeClient.new("<<YOUR_SECRET_KEY>>

session = client.v1.checkout.sessions.expire('cs_test_a1Ae6ClgOkjygKwrf9B3L6ITtUuZW4Xx9FivL6DZYoYFdfAefQxsYpJJd3')

client = StripeClient("<<YOUR_SECRET_KEY>>

session = client.v1.checkout.sessions.expire(
  "cs_test_a1Ae6ClgOkjygKwrf9B3L6ITtUuZW4Xx9FivL6DZYoYFdfAefQxsYpJJd3",
)

$stripe = new \Stripe\StripeClient('<<YOUR_SECRET_KEY>>

$session = $stripe->checkout->sessions->expire(
  'cs_test_a1Ae6ClgOkjygKwrf9B3L6ITtUuZW4Xx9FivL6DZYoYFdfAefQxsYpJJd3',
  []
);

StripeClient client = new StripeClient("<<YOUR_SECRET_KEY>>

SessionExpireParams params = SessionExpireParams.builder().build();

Session session =
  client.v1().checkout().sessions().expire(
    "cs_test_a1Ae6ClgOkjygKwrf9B3L6ITtUuZW4Xx9FivL6DZYoYFdfAefQxsYpJJd3",
    params
  );

const stripe = require('stripe')('<<YOUR_SECRET_KEY>>

const session = await stripe.checkout.sessions.expire(
  'cs_test_a1Ae6ClgOkjygKwrf9B3L6ITtUuZW4Xx9FivL6DZYoYFdfAefQxsYpJJd3'
);

sc := stripe.NewClient("<<YOUR_SECRET_KEY>>
params := &stripe.CheckoutSessionExpireParams{
  Session: stripe.String("cs_test_a1Ae6ClgOkjygKwrf9B3L6ITtUuZW4Xx9FivL6DZYoYFdfAefQxsYpJJd3"),
}
result, err := sc.V1CheckoutSessions.Expire(context.TODO(), params)

var client = new StripeClient("<<YOUR_SECRET_KEY>>
var service = client.V1.Checkout.Sessions;
Stripe.Checkout.Session session = service.Expire(
    "cs_test_a1Ae6ClgOkjygKwrf9B3L6ITtUuZW4Xx9FivL6DZYoYFdfAefQxsYpJJd3");

Response

{
  "id": "cs_test_a1Ae6ClgOkjygKwrf9B3L6ITtUuZW4Xx9FivL6DZYoYFdfAefQxsYpJJd3",
  "object": "checkout.session",
  "after_expiration": null,
  "allow_promotion_codes": null,
  "amount_subtotal": 2198,
  "amount_total": 2198,
  "automatic_tax": {
    "enabled": false,
    "status": null
  },
  "billing_address_collection": null,
  "cancel_url": null,
  "client_reference_id": null,
  "consent": null,
  "consent_collection": null,
  "created": 1679434412,
  "currency": "usd",
  "custom_fields": [],
  "custom_text": {
    "shipping_address": null,
    "submit": null
  },
  "customer": null,
  "customer_creation": "if_required",
  "customer_details": null,
  "customer_email": null,
  "expires_at": 1679520812,
  "invoice": null,
  "invoice_creation": {
    "enabled": false,
    "invoice_data": {
      "account_tax_ids": null,
      "custom_fields": null,
      "description": null,
      "footer": null,
      "metadata": {},
      "rendering_options": null
    }
  },
  "livemode": false,
  "locale": null,
  "metadata": {},
  "mode": "payment",
  "payment_intent": null,
  "payment_link": null,
  "payment_method_collection": "always",
  "payment_method_options": {},
  "payment_method_types": [
    "card"
  ],
  "payment_status": "unpaid",
  "phone_number_collection": {
    "enabled": false
  },
  "recovered_from": null,
  "setup_intent": null,
  "shipping_address_collection": null,
  "shipping_cost": null,
  "shipping_details": null,
  "shipping_options": [],
  "status": "expired",
  "submit_type": null,
  "subscription": null,
  "success_url": "https://example.com/success",
  "total_details": {
    "amount_discount": 0,
    "amount_shipping": 0,
    "amount_tax": 0
  },
  "url": null
}