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, expandable (can be expanded into an object with the expand request parameter)) 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_page or ui_mode: elements. For ui_mode: embedded_page, the client secret is to be used when initializing Stripe.js embedded checkout. For ui_mode: elements, use the client secret with initCheckout 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 (ISO 3166-2).

    • 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. You can’t set this parameter if ui_mode is custom.

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

    • custom_fields.dropdown.default_value (string, nullable) The value that pre-fills 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 pre-fills 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 pre-fills 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. You can’t set this parameter if ui_mode is custom.

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

    • custom_text.after_submit.message (string) Text can 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 can 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 can 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 can be up to 1200 characters in length.

• customer (string, nullable, expandable (can be expanded into an object with the expand request parameter)) 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_account (string, nullable) The ID of the account for this Session.

• 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 (ISO 3166-2).

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

    The maximum length is 150 characters.

  • 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.

    The maximum length is 150 characters.

  • 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, pl_nip, it_cf, fo_vat, gi_tin, py_ruc, tw_vat, th_vat, jp_cn, jp_rn, jp_trn, li_uid, li_vat, lk_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
      • fo_vat
      • gb_vat
      • ge_vat
      • gi_tin
      • gn_nif
      • hk_br
      • hr_oib
      • hu_tin
      • id_npwp
      • il_vat
      • in_gst
      • is_vat
      • it_cf
      • jp_cn
      • jp_rn
      • jp_trn
      • ke_pin
      • kg_tin
      • kh_tin
      • kr_brn
      • kz_bin
      • la_tin
      • li_uid
      • li_vat
      • lk_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
      • pl_nip
      • py_ruc
      • 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, expandable (can be expanded into an object with the expand request parameter)) Coupon attached to the Checkout Session.

  • discounts.promotion_code (string, nullable, expandable (can be expanded into an object with the expand request parameter)) 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.

• integration_identifier (string, nullable) The integration identifier for this Checkout Session. Multiple Checkout Sessions can have the same integration identifier.

• invoice (string, nullable, expandable (can be expanded into an object with the expand request parameter)) 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, expandable (can be expanded into an object with the expand request parameter)) 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, expandable (can be expanded into an object with the expand request parameter)) 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, expandable (can be expanded into an object with the expand request parameter)) 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, expandable (can be expanded into an object with the expand request parameter)) 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, expandable (can be expanded into an object with the expand request parameter)) The ID of the customer associated with this discount.

        • line_items.data.discounts.discount.customer_account (string, nullable) The ID of the account representing 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, expandable (can be expanded into an object with the expand request parameter)) 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, expandable (can be expanded into an object with the expand request parameter)) 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.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.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, expandable (can be expanded into an object with the expand request parameter)) 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, expandable (can be expanded into an object with the expand request parameter)) 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 the smallest currency unit 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 the smallest currency unit 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) If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

      • 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, expandable (can be expanded into an object with the expand request parameter)) 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, expandable (can be expanded into an object with the expand request parameter)) 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 the smallest currency unit 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 the smallest currency unit 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, expandable (can be expanded into an object with the expand request parameter)) 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) If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

        • 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:

          • admissions_tax Admissions Tax

          • amusement_tax Amusement Tax

          • attendance_tax Attendance Tax

          • communications_tax Communications Tax

          • entertainment_tax Entertainment Tax

          • gross_receipts_tax Gross Receipts Tax

          • gst Goods and Services Tax

          • hospitality_tax Hospitality Tax

          • hst Harmonized Sales Tax

          • igst Integrated Goods and Services Tax

          • jct Japanese Consumption Tax

          • lease_tax Chicago Lease Tax

          • luxury_tax Luxury Tax

          • pst Provincial Sales Tax

          • qst Quebec Sales Tax

          • resort_tax Resort Tax

          • retail_delivery_fee Retail Delivery Fee

          • rst Retail Sales Tax

          • sales_tax Sales Tax

          • service_tax Service Tax

          • tourism_tax Tourism 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 the smallest currency unit.

  • 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) If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

• 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

• managed_payments (object, nullable) Settings for Managed Payments for this Checkout Session and resulting PaymentIntents, Invoices, and Subscriptions.

  • managed_payments.enabled (boolean) Indicates whether Managed Payments is enabled for this session.

• 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, expandable (can be expanded into an object with the expand request parameter)) 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, expandable (can be expanded into an object with the expand request parameter)) 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, expandable (can be expanded into an object with the expand request parameter)) 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. The default value is automatic. 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. You can’t set this parameter if ui_mode is custom.

      • 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: DE, 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.payto (object, nullable) If the Checkout Session’s payment_method_types includes payto, this hash contains the configurations that will be applied to each payment attempt of that type.

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

      • payment_method_options.payto.mandate_options.amount (integer, nullable) Amount that will be collected. It is required when amount_type is fixed.

      • payment_method_options.payto.mandate_options.amount_type (enum, nullable) The type of amount that will be collected. The amount charged must be exact or up to the value of amount param for fixed or maximum type respectively. Defaults to maximum. Possible enum values:

        • fixed The amount is the exact amount that will be charged.

        • maximum The amount is the maximum amount that can be charged.

      • payment_method_options.payto.mandate_options.end_date (string, nullable) Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.

      • payment_method_options.payto.mandate_options.payment_schedule (enum, nullable) The periodicity at which payments will be collected. Defaults to adhoc. Possible enum values:

        • adhoc Payments will be made ad hoc

        • annual Payments will be made annually

        • daily Payments will be made daily

        • fortnightly Payments will be made fortnightly

        • monthly Payments will be made monthly

        • quarterly Payments will be made quarterly

        • semi_annual Payments will be made semi-annually

        • weekly Payments will be made weekly

      • payment_method_options.payto.mandate_options.payments_per_period (integer, nullable) The number of payments that will be made during a payment period. Defaults to 1 except for when payment_schedule is adhoc. In that case, it defaults to no limit.

      • payment_method_options.payto.mandate_options.purpose (enum, nullable) The purpose for which payments are made. Has a default value based on your merchant category code. Possible enum values:

        • dependant_support Transactions are made for dependant support reasons

        • government Transactions are made for government reasons

        • loan Transactions are made for loan reasons

        • mortgage Transactions are made for mortgage reasons

        • other Transactions are made for other reasons

        • pension Transactions are made for pension reasons

        • personal Transactions are made for personal reasons

        • retail Transactions are made for retail reasons

        • salary Transactions are made for salary reasons

        • tax Transactions are made for tax reasons

        • utility Transactions are made for utility reasons

      • payment_method_options.payto.mandate_options.start_date (string, nullable) Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.

    • payment_method_options.payto.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.mandate_options (object, nullable) Additional fields for mandate creation.

      • payment_method_options.pix.mandate_options.amount (integer, nullable) Amount to be charged for future payments.

      • payment_method_options.pix.mandate_options.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.mandate_options.amount_type (enum, nullable) Type of amount. Possible enum values:

        • fixed The exact amount for future payments.

        • maximum The maximum amount for future payments.

      • payment_method_options.pix.mandate_options.currency (enum, nullable) Three-letter ISO currency code, in lowercase.

      • payment_method_options.pix.mandate_options.end_date (string, nullable) Date when the mandate expires and no further payments will be charged, in YYYY-MM-DD.

      • payment_method_options.pix.mandate_options.payment_schedule (enum, nullable) Schedule at which the future payments will be charged. Possible enum values:

        • halfyearly The future payments will be charged half-yearly.

        • monthly The future payments will be charged monthly.

        • quarterly The future payments will be charged quarterly.

        • weekly The future payments will be charged weekly.

        • yearly The future payments will be charged yearly.

      • payment_method_options.pix.mandate_options.reference (string, nullable) Subscription name displayed to buyers in their bank app.

      • payment_method_options.pix.mandate_options.start_date (string, nullable) Start date of the mandate, in YYYY-MM-DD.

    • 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.

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

  • 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.

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

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

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

      • payment_method_options.upi.mandate_options.amount (integer, nullable) Amount to be charged for future payments.

      • payment_method_options.upi.mandate_options.amount_type (enum, nullable) One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param. Possible enum values:

        • fixed If fixed, the amount param refers to the exact amount to be charged in future payments.

        • maximum If maximum, the amount charged can be up to the value passed for the amount param.

      • payment_method_options.upi.mandate_options.description (string, nullable) A description of the mandate or subscription that is meant to be displayed to the customer.

        The maximum length is 20 characters.

      • payment_method_options.upi.mandate_options.end_date (timestamp, nullable) End date of the mandate or subscription.

    • payment_method_options.upi.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 (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. The default value is automatic. 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_page. 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_page or ui_mode: elements. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method’s app or site.

• saved_payment_method_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, expandable (can be expanded into an object with the expand request parameter)) 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, expandable (can be expanded into an object with the expand request parameter)) The ID of the ShippingRate for this order.

  • shipping_cost.taxes (array of objects, nullable, expandable (can be expanded into an object with the expand request parameter)) 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) If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

      • 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:

        • admissions_tax Admissions Tax

        • amusement_tax Amusement Tax

        • attendance_tax Attendance Tax

        • communications_tax Communications Tax

        • entertainment_tax Entertainment Tax

        • gross_receipts_tax Gross Receipts Tax

        • gst Goods and Services Tax

        • hospitality_tax Hospitality Tax

        • hst Harmonized Sales Tax

        • igst Integrated Goods and Services Tax

        • jct Japanese Consumption Tax

        • lease_tax Chicago Lease Tax

        • luxury_tax Luxury Tax

        • pst Provincial Sales Tax

        • qst Quebec Sales Tax

        • resort_tax Resort Tax

        • retail_delivery_fee Retail Delivery Fee

        • rst Retail Sales Tax

        • sales_tax Sales Tax

        • service_tax Service Tax

        • tourism_tax Tourism 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 the smallest currency unit.

• 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, expandable (can be expanded into an object with the expand request parameter)) 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:

  • autopay 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, expandable (can be expanded into an object with the expand request parameter)) 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, expandable (can be expanded into an object with the expand request parameter)) 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, expandable (can be expanded into an object with the expand request parameter)) The ID of the customer associated with this discount.

        • total_details.breakdown.discounts.discount.customer_account (string, nullable) The ID of the account representing 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, expandable (can be expanded into an object with the expand request parameter)) 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, expandable (can be expanded into an object with the expand request parameter)) 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) If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

        • 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:

          • admissions_tax Admissions Tax

          • amusement_tax Amusement Tax

          • attendance_tax Attendance Tax

          • communications_tax Communications Tax

          • entertainment_tax Entertainment Tax

          • gross_receipts_tax Gross Receipts Tax

          • gst Goods and Services Tax

          • hospitality_tax Hospitality Tax

          • hst Harmonized Sales Tax

          • igst Integrated Goods and Services Tax

          • jct Japanese Consumption Tax

          • lease_tax Chicago Lease Tax

          • luxury_tax Luxury Tax

          • pst Provincial Sales Tax

          • qst Quebec Sales Tax

          • resort_tax Resort Tax

          • retail_delivery_fee Retail Delivery Fee

          • rst Retail Sales Tax

          • sales_tax Sales Tax

          • service_tax Service Tax

          • tourism_tax Tourism 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 the smallest currency unit.

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

  • elements The Checkout Session is displayed using Checkout elements on your website.

  • embedded_page The Checkout Session is displayed as an embedded form on your website.

  • hosted_page The Checkout Session is displayed on a hosted page that customers get redirected to.

• url (string, nullable) The URL to the Checkout Session. Applies to Checkout Sessions with ui_mode: hosted_page. Redirect customers to this URL to take them to Checkout. If you’re using Custom Domains, 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"
}