Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Create a Checkout Session 

Checkout
Checkout Sessions
Create a Checkout Session

Creates a Checkout Session object.

Parameters

  • automatic_taxobject

    Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.

    • automatic_tax.enabledbooleanRequired

      Set to true to calculate tax automatically using the customer’s location.

      Enabling this parameter causes Checkout to collect any billing address information necessary for tax calculation.

    • automatic_tax.liabilityobjectConnect only

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

        Type of the account referenced in the request.

        Possible enum values
        account

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

        self

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

      • automatic_tax.liability.accountstringRequired only if type is account

        The connected account being referenced when type is account.

  • client_reference_idstring

    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.

  • customerstring

    ID of an existing Customer, if one exists. In payment mode, the customer’s most recently saved card payment method will be used to prefill the email, name, card details, and billing address on the Checkout page. In subscription mode, the customer’s default payment method will be used if it’s a card, otherwise the most recently saved card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer’s card details.

    If the Customer already has a valid email set, the email will be prefilled and not editable in Checkout. If the Customer does not have a valid email, Checkout will set the email entered during the session on the Customer.

    If blank for Checkout Sessions in subscription mode or with customer_creation set as always in payment mode, Checkout will create a new Customer object based on information provided during the payment flow.

    You can set payment_intent_data.setup_future_usage to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.

  • customer_emailstring

    If provided, this value will be used when the Customer object is created. If not provided, customers will be asked to enter their email address. Use this parameter to prefill customer data if you already have an email on file. To access information about the customer once a session is complete, use the customer field.

  • line_itemsarray of objectsRequired conditionally

    A list of items the customer is purchasing. Use this parameter to pass one-time or recurring Prices. The parameter is required for payment and subscription mode.

    For payment mode, there is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen.

    For subscription mode, there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices will be on the initial invoice only.

    • line_items.adjustable_quantityobject

      When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.

      • line_items.adjustable_quantity.enabledbooleanRequired

        Set to true if the quantity can be adjusted to any non-negative integer.

      • line_items.adjustable_quantity.maximuminteger

        The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999.

      • line_items.adjustable_quantity.minimuminteger

        The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.

    • line_items.dynamic_tax_ratesarray of strings

      The tax rates that will be applied to this line item depending on the customer’s billing/shipping address. We currently support the following countries: US, GB, AU, and all countries in the EU.

    • line_items.pricestringRequired conditionally

      The ID of the Price or Plan object. One of price or price_data is required.

    • line_items.price_dataobjectRequired conditionally

      Data used to generate a new Price object inline. One of price or price_data is required.

      • line_items.price_data.currencyenumRequired

        Three-letter ISO currency code, in lowercase. Must be a supported currency.

      • line_items.price_data.productstringRequired conditionally

        The ID of the Product that this Price will belong to. One of product or product_data is required.

      • line_items.price_data.product_dataobjectRequired conditionally

        Data used to generate a new Product object inline. One of product or product_data is required.

        • line_items.price_data.product_data.namestringRequired

          The product’s name, meant to be displayable to the customer.

        • line_items.price_data.product_data.descriptionstring

          The product’s description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.

        • line_items.price_data.product_data.imagesarray of strings

          A list of up to 8 URLs of images for this product, meant to be displayable to the customer.

        • line_items.price_data.product_data.metadataobject

          Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

        • line_items.price_data.product_data.tax_codestringRecommended if calculating taxes

          A tax code ID.

      • line_items.price_data.recurringobject

        The recurring components of a price such as interval and interval_count.

        • line_items.price_data.recurring.intervalenumRequired

          Specifies billing frequency. Either day, week, month or year.

          Possible enum values
          day
          month
          week
          year

        • line_items.price_data.recurring.interval_countinteger

          The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).

      • line_items.price_data.tax_behaviorenumRecommended if calculating taxes

        Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.

        Possible enum values
        exclusive
        inclusive
        unspecified

      • line_items.price_data.unit_amountintegerRequired conditionally

        A non-negative integer in cents representing how much to charge. One of unit_amount or unit_amount_decimal is required.

      • line_items.price_data.unit_amount_decimalstringRequired conditionally

        Same as unit_amount, but accepts a decimal value in cents with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.

    • line_items.quantityintegerRequired conditionally

      The quantity of the line item being purchased. Quantity should not be defined when recurring.usage_type=metered.

    • line_items.tax_ratesarray of strings

      The tax rates which apply to this line item.

  • metadataobject

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

  • modeenumRequired

    The mode of the Checkout Session. Pass subscription if the Checkout Session includes at least one recurring item.

    Possible enum values
    payment

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

    setup

    Save payment details to charge your customers later.

    subscription

    Use Stripe Billing to set up fixed-price subscriptions.

  • return_urlstringRequired conditionally

    The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method’s app or site. This parameter is required if ui_mode is embedded or custom and redirect-based payment methods are enabled on the session.

  • success_urlstringRequired conditionally

    The URL to which Stripe should send customers when payment or setup is complete. This parameter is not allowed if ui_mode is embedded or custom. If you’d like to use information from the successful Checkout Session on your page, read the guide on customizing your success page.

  • ui_modeenum

    The UI mode of the Session. Defaults to hosted.

    Possible enum values
    custom

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

    embedded

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

    hosted

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

More parameters

  • adaptive_pricingobject

    Settings for price localization with Adaptive Pricing.

  • after_expirationobject

    Configure actions after a Checkout Session has expired.

    • after_expiration.recoveryobject

      Configure a Checkout Session that can be used to recover an expired session.

      • after_expiration.recovery.enabledbooleanRequired

        If true, a recovery URL will be generated to recover this Checkout Session if it expires before a successful transaction is completed. It will be attached to the Checkout Session object upon expiration.

      • after_expiration.recovery.allow_promotion_codesboolean

        Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to false

  • allow_promotion_codesboolean

    Enables user redeemable promotion codes.

  • billing_address_collectionenum

    Specify whether Checkout should collect the customer’s billing address. Defaults to auto.

    Possible enum values
    auto

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

    required

    Checkout will always collect the customer’s billing address.

  • cancel_urlstring

    If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is embedded or custom.

  • consent_collectionobject

    Configure fields for the Checkout Session to gather active consent from customers.

    • consent_collection.payment_method_reuse_agreementobject

      Determines the display of payment method reuse agreement text in the UI. If set to hidden, it will hide legal text related to the reuse of a payment method.

      • consent_collection.payment_method_reuse_agreement.positionenumRequired

        Determines the position and visibility of the payment method reuse agreement in the UI. When set to auto, Stripe’s defaults will be used. When set to hidden, the payment method reuse agreement text will always be hidden in the UI.

        Possible enum values
        auto

        Uses Stripe defaults to determine the visibility and position of the payment method reuse agreement.

        hidden

        Hides the payment method reuse agreement.

    • consent_collection.promotionsenum

      If set to auto, enables the collection of customer consent for promotional communications. The Checkout Session will determine whether to display an option to opt into promotional communication from the merchant depending on the customer’s locale. Only available to US merchants.

      Possible enum values
      auto

      Enable the collection of customer consent for promotional communications. The Checkout Session will determine whether to display an option to opt into promotional communication from the merchant depending on if a customer is provided, and if that customer has consented to receiving promotional communications from the merchant in the past.

      none

      Checkout will not collect customer consent for promotional communications.

    • consent_collection.terms_of_serviceenum

      If set to required, it requires customers to check a terms of service checkbox before being able to pay. There must be a valid terms of service URL set in your Dashboard settings.

      Possible enum values
      none

      Does not display checkbox for the terms of service agreement.

      required

      Displays a checkbox for the terms of service agreement which requires customer to check before being able to pay.

  • currencyenumRequired conditionally

    Three-letter ISO currency code, in lowercase. Must be a supported currency. Required in setup mode when payment_method_types is not set.

  • custom_fieldsarray of objects

    Collect additional information from your customer using custom fields. Up to 3 fields are supported.

    • custom_fields.keystringRequired

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

      The label for the field, displayed to the customer.

      • custom_fields.label.customstringRequired

        Custom text for the label, displayed to the customer. Up to 50 characters.

      • custom_fields.label.typeenumRequired

        The type of the label.

        Possible enum values
        custom

        Set a custom label for the field.

    • custom_fields.typeenumRequired

      The type of the field.

      Possible enum values
      dropdown

      Provide a list of options for your customer to select.

      numeric

      Collect a numbers-only field from your customer.

      text

      Collect a string field from your customer.

    • custom_fields.dropdownobject

      Configuration for type=dropdown fields.

      • custom_fields.dropdown.optionsarray of objectsRequired

        The options available for the customer to select. Up to 200 options allowed.

        • custom_fields.dropdown.options.labelstringRequired

          The label for the option, displayed to the customer. Up to 100 characters.

        • custom_fields.dropdown.options.valuestringRequired

          The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.

      • custom_fields.dropdown.default_valuestring

        The value that will pre-fill the field on the payment page.Must match a value in the options array.

    • custom_fields.numericobject

      Configuration for type=numeric fields.

      • custom_fields.numeric.default_valuestring

        The value that will pre-fill the field on the payment page.

      • custom_fields.numeric.maximum_lengthinteger

        The maximum character length constraint for the customer’s input.

      • custom_fields.numeric.minimum_lengthinteger

        The minimum character length requirement for the customer’s input.

    • custom_fields.optionalboolean

      Whether the customer is required to complete the field before completing the Checkout Session. Defaults to false.

    • custom_fields.textobject

      Configuration for type=text fields.

      • custom_fields.text.default_valuestring

        The value that will pre-fill the field on the payment page.

      • custom_fields.text.maximum_lengthinteger

        The maximum character length constraint for the customer’s input.

      • custom_fields.text.minimum_lengthinteger

        The minimum character length requirement for the customer’s input.

  • custom_textobject

    Display additional text for your customers using custom text.

    • custom_text.after_submitobject

      Custom text that should be displayed after the payment confirmation button.

      • custom_text.after_submit.messagestringRequired

        Text may be up to 1200 characters in length.

    • custom_text.shipping_addressobject

      Custom text that should be displayed alongside shipping address collection.

      • custom_text.shipping_address.messagestringRequired

        Text may be up to 1200 characters in length.

    • custom_text.submitobject

      Custom text that should be displayed alongside the payment confirmation button.

      • custom_text.submit.messagestringRequired

        Text may be up to 1200 characters in length.

    • custom_text.terms_of_service_acceptanceobject

      Custom text that should be displayed in place of the default terms of service agreement text.

      • custom_text.terms_of_service_acceptance.messagestringRequired

        Text may be up to 1200 characters in length.

  • customer_creationenum

    Configure whether a Checkout Session creates a Customer during Session confirmation.

    When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout with customer_details.

    Sessions that don’t create Customers instead are grouped by guest customers in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.

    Can only be set in payment and setup mode.

    Possible enum values
    always

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

    if_required

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

  • customer_updateobject

    Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when customer is provided.

    • customer_update.addressenum

      Describes whether Checkout saves the billing address onto customer.address. To always collect a full billing address, use billing_address_collection. Defaults to never.

      Possible enum values
      auto

      Checkout will automatically determine whether to update the provided Customer object using details from the session.

      never

      Checkout will never update the provided Customer object.

    • customer_update.nameenum

      Describes whether Checkout saves the name onto customer.name. Defaults to never.

      Possible enum values
      auto

      Checkout will automatically determine whether to update the provided Customer object using details from the session.

      never

      Checkout will never update the provided Customer object.

    • customer_update.shippingenum

      Describes whether Checkout saves shipping information onto customer.shipping. To collect shipping information, use shipping_address_collection. Defaults to never.

      Possible enum values
      auto

      Checkout will automatically determine whether to update the provided Customer object using details from the session.

      never

      Checkout will never update the provided Customer object.

  • discountsarray of objects

    The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.

    • discounts.couponstring

      The ID of the coupon to apply to this Session.

    • discounts.promotion_codestring

      The ID of a promotion code to apply to this Session.

  • expires_attimestamp

    The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation.

  • invoice_creationobject

    Generate a post-purchase Invoice for one-time payments.

    • invoice_creation.enabledbooleanRequired

      Set to true to enable invoice creation.

    • invoice_creation.invoice_dataobject

      Parameters passed when creating invoices for payment-mode Checkout Sessions.

      • invoice_creation.invoice_data.account_tax_idsarray of strings

        The account tax IDs associated with the invoice.

      • invoice_creation.invoice_data.custom_fieldsarray of objects

        Default custom fields to be displayed on invoices for this customer.

        • invoice_creation.invoice_data.custom_fields.namestringRequired

          The name of the custom field. This may be up to 40 characters.

        • invoice_creation.invoice_data.custom_fields.valuestringRequired

          The value of the custom field. This may be up to 140 characters.

      • invoice_creation.invoice_data.descriptionstring

        An arbitrary string attached to the object. Often useful for displaying to users.

      • invoice_creation.invoice_data.footerstring

        Default footer to be displayed on invoices for this customer.

      • invoice_creation.invoice_data.issuerobjectConnect only

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

          Type of the account referenced in the request.

          Possible enum values
          account

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

          self

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

        • invoice_creation.invoice_data.issuer.accountstringRequired only if type is account

          The connected account being referenced when type is account.

      • invoice_creation.invoice_data.metadataobject

        Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

      • invoice_creation.invoice_data.rendering_optionsobject

        Default options for invoice PDF rendering for this customer.

        • invoice_creation.invoice_data.rendering_options.amount_tax_displayenum

          How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of exclude_tax or include_inclusive_tax. include_inclusive_tax will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. exclude_tax will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.

          Possible enum values
          exclude_tax
          include_inclusive_tax

        • invoice_creation.invoice_data.rendering_options.templatestring

          ID of the invoice rendering template to use for this invoice.

  • localeenum

    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
    Show 31 more

  • optional_itemsarray of objects

    A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring Prices.

    There is a maximum of 10 optional items allowed on a Checkout Session, and the existing limits on the number of line items allowed on a Checkout Session apply to the combined number of line items and optional items.

    For payment mode, there is a maximum of 100 combined line items and optional items, however it is recommended to consolidate items if there are more than a few dozen.

    For subscription mode, there is a maximum of 20 line items and optional items with recurring Prices and 20 line items and optional items with one-time Prices.

    • optional_items.pricestringRequired

      The ID of the Price or Plan object.

    • optional_items.quantityintegerRequired

      The initial quantity of the line item created when a customer chooses to add this optional item to their order.

    • optional_items.adjustable_quantityobject

      When set, provides configuration for the customer to adjust the quantity of the line item created when a customer chooses to add this optional item to their order.

      • optional_items.adjustable_quantity.enabledbooleanRequired

        Set to true if the quantity can be adjusted to any non-negative integer.

      • optional_items.adjustable_quantity.maximuminteger

        The maximum quantity of this item the customer can purchase. By default this value is 99. You can specify a value up to 999999.

      • optional_items.adjustable_quantity.minimuminteger

        The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the minimum configured here is greater than 0. By default this value is 0.

  • origin_contextenum

    Where the user is coming from. This informs the optimizations that are applied to the session. For example, a session originating from a mobile app may behave more like a native app, depending on the platform. This parameter is currently not allowed if ui_mode is custom.

    Possible enum values
    mobile_app

    The Checkout Session originates from a mobile app.

    web

    The Checkout Session originates from a web page.

  • payment_intent_dataobject

    A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in payment mode.

    • payment_intent_data.application_fee_amountintegerConnect only

      The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner’s Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents use case for connected accounts.

    • payment_intent_data.capture_methodenum

      Controls when the funds will be captured from the customer’s account.

      Possible enum values
      automatic

      Stripe automatically captures funds when the customer authorizes the payment.

      automatic_async

      (Default) Stripe asynchronously captures funds when the customer authorizes the payment. Recommended over capture_method=automatic due to improved latency. Read the integration guide for more information.

      manual

      Place a hold on the funds when the customer authorizes the payment, but don’t capture the funds until later. (Not all payment methods support this.)

    • payment_intent_data.descriptionstring

      An arbitrary string attached to the object. Often useful for displaying to users.

    • payment_intent_data.metadataobject

      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    • payment_intent_data.on_behalf_ofstringConnect only

      The Stripe account ID for which these funds are intended. For details, see the PaymentIntents use case for connected accounts.

    • payment_intent_data.receipt_emailstring

      Email address that the receipt for the resulting payment will be sent to. If receipt_email is specified for a payment in live mode, a receipt will be sent regardless of your email settings.

    • payment_intent_data.setup_future_usageenum

      Indicates that you intend to make future payments with the payment method collected by this Checkout Session.

      When setting this to on_session, Checkout will show a notice to the customer that their payment details will be saved.

      When setting this to off_session, Checkout will show a notice to the customer that their payment details will be saved and used for future payments.

      If a Customer has been provided or Checkout creates a new Customer, Checkout will attach the payment method to the Customer.

      If Checkout does not create a Customer, the payment method is not attached to a Customer. To reuse the payment method, you can retrieve it from the Checkout Session’s PaymentIntent.

      When processing card payments, Checkout also uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.

      Possible enum values
      off_session

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

      on_session

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

    • payment_intent_data.shippingobject

      Shipping information for this payment.

      • payment_intent_data.shipping.addressobjectRequired

        Shipping address.

        • payment_intent_data.shipping.address.line1stringRequired

          Address line 1 (e.g., street, PO Box, or company name).

        • payment_intent_data.shipping.address.citystring

          City, district, suburb, town, or village.

        • payment_intent_data.shipping.address.countrystring

          Two-letter country code (ISO 3166-1 alpha-2).

        • payment_intent_data.shipping.address.line2string

          Address line 2 (e.g., apartment, suite, unit, or building).

        • payment_intent_data.shipping.address.postal_codestring

          ZIP or postal code.

        • payment_intent_data.shipping.address.statestring

          State, county, province, or region.

      • payment_intent_data.shipping.namestringRequired

        Recipient name.

      • payment_intent_data.shipping.carrierstring

        The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.

      • payment_intent_data.shipping.phonestring

        Recipient phone (including extension).

      • payment_intent_data.shipping.tracking_numberstring

        The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

    • payment_intent_data.statement_descriptorstring

      Text that appears on the customer’s statement as the statement descriptor for a non-card charge. This value overrides the account’s default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs.

      Setting this value for a card charge returns an error. For card charges, set the statement_descriptor_suffix instead.

    • payment_intent_data.statement_descriptor_suffixstring

      Provides information about a card charge. Concatenated to the account’s statement descriptor prefix to form the complete statement descriptor that appears on the customer’s statement.

    • payment_intent_data.transfer_dataobjectConnect only

      The parameters used to automatically create a Transfer when the payment succeeds. For more information, see the PaymentIntents use case for connected accounts.

      • payment_intent_data.transfer_data.destinationstringRequired

        If specified, successful charges will be attributed to the destination account for tax reporting, and the funds from charges will be transferred to the destination account. The ID of the resulting transfer will be returned on the successful charge’s transfer field.

      • payment_intent_data.transfer_data.amountinteger

        The amount that will be transferred automatically when a charge succeeds.

    • payment_intent_data.transfer_groupstringConnect only

      A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.

  • payment_method_collectionenum

    Specify whether Checkout should collect a payment method. When set to if_required, Checkout will not collect a payment method when the total due for the session is 0. This may occur if the Checkout Session includes a free trial or a discount.

    Can only be set in subscription mode. Defaults to always.

    If you’d like information on how to collect a payment method outside of Checkout, read the guide on configuring subscriptions with a free trial.

    Possible enum values
    always

    The Checkout Session will always collect a PaymentMethod.

    if_required

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

  • payment_method_configurationstring

    The ID of the payment method configuration to use with this Checkout session.

  • payment_method_dataobject

    This parameter allows you to set some attributes on the payment method created during a Checkout session.

    • payment_method_data.allow_redisplayenum

      Allow redisplay will be set on the payment method on confirmation and indicates whether this payment method can be shown again to the customer in a checkout flow. Only set this field if you wish to override the allow_redisplay value determined by Checkout.

      Possible enum values
      always

      Use always to indicate that this payment method can always be shown to a customer in a checkout flow.

      limited

      Use limited to indicate that this payment method can’t always be shown to a customer in a checkout flow. For example, it can only be shown in the context of a specific subscription.

      unspecified

      This is the default value for payment methods where allow_redisplay wasn’t set.

  • payment_method_optionsobject

    Payment-method-specific configuration.

    • payment_method_options.acss_debitobject

      contains details about the ACSS Debit payment method options.

      • payment_method_options.acss_debit.currencyenum

        Three-letter ISO currency code, in lowercase. Must be a supported currency. This is only accepted for Checkout Sessions in setup mode.

        Possible enum values
        cad

        Canadian dollars

        usd

        US dollars

      • payment_method_options.acss_debit.mandate_optionsobject

        Additional fields for Mandate creation

        • payment_method_options.acss_debit.mandate_options.custom_mandate_urlstring

          A URL for custom mandate text to render during confirmation step. The URL will be rendered with additional GET parameters payment_intent and payment_intent_client_secret when confirming a Payment Intent, or setup_intent and setup_intent_client_secret when confirming a Setup Intent.

        • payment_method_options.acss_debit.mandate_options.default_forarray of enums

          List of Stripe products where this mandate can be selected automatically. Only usable in setup mode.

          Possible enum values
          invoice

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

          subscription

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

        • payment_method_options.acss_debit.mandate_options.interval_descriptionstring

          Description of the mandate interval. Only required if ‘payment_schedule’ parameter is ‘interval’ or ‘combined’.

        • payment_method_options.acss_debit.mandate_options.payment_scheduleenum

          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_typeenum

          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_usageenum

        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_datestring

        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_methodenum

        Verification method for the intent

        Possible enum values
        automatic

        Instant verification with fallback to microdeposits.

        instant

        Instant verification.

        microdeposits

        Verification using microdeposits.

    • payment_method_options.affirmobject

      contains details about the Affirm payment method options.

      • payment_method_options.affirm.setup_future_usageenum

        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_clearpayobject

      contains details about the Afterpay Clearpay payment method options.

      • payment_method_options.afterpay_clearpay.setup_future_usageenum

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

      contains details about the Alipay payment method options.

      • payment_method_options.alipay.setup_future_usageenum

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

      contains details about the AmazonPay payment method options.

      • payment_method_options.amazon_pay.setup_future_usageenum

        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_debitobject

      contains details about the AU Becs Debit payment method options.

      • payment_method_options.au_becs_debit.setup_future_usageenum

        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_datestring

        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_debitobject

      contains details about the Bacs Debit payment method options.

      • payment_method_options.bacs_debit.mandate_optionsobject

        Additional fields for Mandate creation

        • payment_method_options.bacs_debit.mandate_options.reference_prefixstringPreview feature

          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_usageenum

        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_datestring

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

      contains details about the Bancontact payment method options.

      • payment_method_options.bancontact.setup_future_usageenum

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

      contains details about the Boleto payment method options.

      • payment_method_options.boleto.expires_after_daysinteger

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

      • payment_method_options.boleto.setup_future_usageenum

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

      contains details about the Card payment method options.

      • payment_method_options.card.installmentsobject

        Installment options for card payments

        • payment_method_options.card.installments.enabledboolean

          Setting to true enables installments for this Checkout Session. Setting to false will prevent any installment plan from applying to a payment.

      • payment_method_options.card.request_extended_authorizationenum

        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_authorizationenum

        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_multicaptureenum

        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_overcaptureenum

        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_secureenumadvanced

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

        Restrictions to apply to the card payment method. For example, you can block specific card brands.

        • payment_method_options.card.restrictions.brands_blockedarray of enums

          Specify the card brands to block in the Checkout Session. If a customer enters or selects a card belonging to a blocked brand, they can’t complete the Session.

          Possible enum values
          american_express

          Include american_express to block American Express cards.

          discover_global_network

          Include discover_global_network to block all cards within the Discover Global Network. This encompasses the following card brands:

          • Discover
          • Diners Club
          • JCB
          • UnionPay
          • Elo
          mastercard

          Include mastercard to block Mastercard cards.

          visa

          Include visa to block Visa cards.

      • payment_method_options.card.setup_future_usageenum

        Indicates that you intend to make future payments with this PaymentIntent’s payment method.

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

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

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

        Possible enum values
        off_session

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

        on_session

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

      • payment_method_options.card.statement_descriptor_suffix_kanastring

        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_kanjistring

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

      contains details about the Cashapp Pay payment method options.

      • payment_method_options.cashapp.setup_future_usageenum

        Indicates that you intend to make future payments with this PaymentIntent’s payment method.

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

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

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

        Possible enum values
        none

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

        off_session

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

        on_session

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

    • payment_method_options.customer_balanceobject

      contains details about the Customer Balance payment method options.

      • payment_method_options.customer_balance.bank_transferobject

        Configuration for the bank transfer funding type, if the funding_type is set to bank_transfer.

        • payment_method_options.customer_balance.bank_transfer.typeenumRequired

          The list of bank transfer types that this PaymentIntent is allowed to use for funding.

          Possible enum values
          eu_bank_transfer

          eu_bank_transfer bank transfer type

          gb_bank_transfer

          gb_bank_transfer bank transfer type

          jp_bank_transfer

          jp_bank_transfer bank transfer type

          mx_bank_transfer

          mx_bank_transfer bank transfer type

          us_bank_transfer

          us_bank_transfer bank transfer type

        • payment_method_options.customer_balance.bank_transfer.eu_bank_transferobject

          Configuration for eu_bank_transfer funding type.

          • payment_method_options.customer_balance.bank_transfer.eu_bank_transfer.countrystringRequired

            The desired country code of the bank account information. Permitted values include: BE, DE, ES, FR, IE, or NL.

        • payment_method_options.customer_balance.bank_transfer.requested_address_typesarray of enums

          List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.

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

          Possible enum values
          aba

          aba bank account address type

          iban

          iban bank account address type

          sepa

          sepa bank account address type

          sort_code

          sort_code bank account address type

          spei

          spei bank account address type

          swift

          swift bank account address type

          zengin

          zengin bank account address type

      • payment_method_options.customer_balance.funding_typeenum

        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_usageenum

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

      contains details about the EPS payment method options.

      • payment_method_options.eps.setup_future_usageenum

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

      contains details about the FPX payment method options.

      • payment_method_options.fpx.setup_future_usageenum

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

      contains details about the Giropay payment method options.

      • payment_method_options.giropay.setup_future_usageenum

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

      contains details about the Grabpay payment method options.

      • payment_method_options.grabpay.setup_future_usageenum

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

      contains details about the Ideal payment method options.

      • payment_method_options.ideal.setup_future_usageenum

        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_payobject

      contains details about the Kakao Pay payment method options.

      • payment_method_options.kakao_pay.capture_methodenum

        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_usageenum

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

      contains details about the Klarna payment method options.

      • payment_method_options.klarna.setup_future_usageenum

        Indicates that you intend to make future payments with this PaymentIntent’s payment method.

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

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

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

        Possible enum values
        none

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

      • payment_method_options.klarna.subscriptionsarray of objects

        Subscription details if the Checkout Session sets up a future subscription.

        • payment_method_options.klarna.subscriptions.intervalenumRequired

          Unit of time between subscription charges.

        • payment_method_options.klarna.subscriptions.next_billingobjectRequired

          Describes the upcoming charge for this subscription.

          • payment_method_options.klarna.subscriptions.next_billing.amountintegerRequired

            The amount of the next charge for the subscription.

          • payment_method_options.klarna.subscriptions.next_billing.datestringRequired

            The date of the next charge for the subscription in YYYY-MM-DD format.

        • payment_method_options.klarna.subscriptions.referencestringRequired

          A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.

        • payment_method_options.klarna.subscriptions.interval_countinteger

          The number of intervals (specified in the interval attribute) between subscription charges. For example, interval=month and interval_count=3 charges every 3 months.

        • payment_method_options.klarna.subscriptions.namestring

          Name for subscription.

    • payment_method_options.konbiniobject

      contains details about the Konbini payment method options.

      • payment_method_options.konbini.expires_after_daysinteger

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

      • payment_method_options.konbini.setup_future_usageenum

        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_cardobject

      contains details about the Korean card payment method options.

      • payment_method_options.kr_card.capture_methodenum

        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_usageenum

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

      contains details about the Link payment method options.

      • payment_method_options.link.setup_future_usageenum

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

      contains details about the Mobilepay payment method options.

      • payment_method_options.mobilepay.setup_future_usageenum

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

      contains details about the Multibanco payment method options.

      • payment_method_options.multibanco.setup_future_usageenum

        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_payobject

      contains details about the Naver Pay payment method options.

      • payment_method_options.naver_pay.capture_methodenum

        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_usageenum

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

      contains details about the OXXO payment method options.

      • payment_method_options.oxxo.expires_after_daysinteger

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

      • payment_method_options.oxxo.setup_future_usageenum

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

      contains details about the P24 payment method options.

      • payment_method_options.p24.setup_future_usageenum

        Indicates that you intend to make future payments with this PaymentIntent’s payment method.

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

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

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

        Possible enum values
        none

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

      • payment_method_options.p24.tos_shown_and_acceptedboolean

        Confirm that the payer has accepted the P24 terms and conditions.

    • payment_method_options.pay_by_bankobject

      contains details about the Pay By Bank payment method options.

    • payment_method_options.paycoobject

      contains details about the PAYCO payment method options.

      • payment_method_options.payco.capture_methodenum

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

      contains details about the PayNow payment method options.

      • payment_method_options.paynow.setup_future_usageenum

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

      contains details about the PayPal payment method options.

      • payment_method_options.paypal.capture_methodenum

        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_localeenum

        Preferred locale of the PayPal checkout page that the customer is redirected to.

        Possible enum values
        cs-CZ

        Czech - The Czech Republic

        da-DK

        Danish - Denmark

        de-AT

        German - Austria

        de-DE

        German - Germany

        de-LU

        German - Luxembourg

        el-GR

        Greek - Greece

        en-GB

        English - United Kingdom

        en-US

        English - United States of America

        es-ES

        Spanish - Spain

        fi-FI

        Finnish - Finland

        Show 11 more

      • payment_method_options.paypal.referencestring

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

      • payment_method_options.paypal.risk_correlation_idstring

        The risk correlation ID for an on-session payment using a saved PayPal payment method.

      • payment_method_options.paypal.setup_future_usageenum

        Indicates that you intend to make future payments with this PaymentIntent’s payment method.

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

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

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

        If you’ve already set setup_future_usage and you’re performing a request using a publishable key, you can only update the value from on_session to off_session.

        Possible enum values
        none

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

        off_session

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

    • payment_method_options.pixobject

      contains details about the Pix payment method options.

      • payment_method_options.pix.expires_after_secondsinteger

        The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.

      • payment_method_options.pix.setup_future_usageenum

        Indicates that you intend to make future payments with this PaymentIntent’s payment method.

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

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

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

        Possible enum values
        none

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

    • payment_method_options.revolut_payobject

      contains details about the RevolutPay payment method options.

      • payment_method_options.revolut_pay.setup_future_usageenum

        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_payobject

      contains details about the Samsung Pay payment method options.

      • payment_method_options.samsung_pay.capture_methodenum

        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_debitobject

      contains details about the Sepa Debit payment method options.

      • payment_method_options.sepa_debit.mandate_optionsobject

        Additional fields for Mandate creation

        • payment_method_options.sepa_debit.mandate_options.reference_prefixstringPreview feature

          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_usageenum

        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_datestring

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

      contains details about the Sofort payment method options.

      • payment_method_options.sofort.setup_future_usageenum

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

      contains details about the Swish payment method options.

      • payment_method_options.swish.referencestring

        The order reference that will be displayed to customers in the Swish application. Defaults to the id of the Payment Intent.

    • payment_method_options.us_bank_accountobject

      contains details about the Us Bank Account payment method options.

      • payment_method_options.us_bank_account.financial_connectionsobject

        Additional fields for Financial Connections Session creation

        • payment_method_options.us_bank_account.financial_connections.permissionsarray of strings

          The list of permissions to request. If this parameter is passed, the payment_method permission must be included. Valid permissions include: balances, ownership, payment_method, and transactions.

        • payment_method_options.us_bank_account.financial_connections.prefetcharray of enums

          List of data features that you would like to retrieve upon account creation.

          Possible enum values
          balances

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

          ownership

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

          transactions

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

      • payment_method_options.us_bank_account.setup_future_usageenum

        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_datestring

        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_methodenum

        Verification method for the intent

        Possible enum values
        automatic

        Instant verification with fallback to microdeposits.

        instant

        Instant verification only.

    • payment_method_options.wechat_payobject

      contains details about the WeChat Pay payment method options.

      • payment_method_options.wechat_pay.clientenumRequired

        The client type that the end customer will pay from

        Possible enum values
        android

        The end customer will pay from an Android app

        ios

        The end customer will pay from an iOS app

        web

        The end customer will pay from web browser

      • payment_method_options.wechat_pay.app_idstring

        The app ID registered with WeChat Pay. Only required when client is ios or android.

      • payment_method_options.wechat_pay.setup_future_usageenum

        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_typesarray of enums

    A list of the types of payment methods (e.g., card) this Checkout Session can accept.

    You can omit this attribute to manage your payment methods from the Stripe Dashboard. See Dynamic Payment Methods for more details.

    Read more about the supported payment methods and their requirements in our payment method details guide.

    If multiple payment methods are passed, Checkout will dynamically reorder them to prioritize the most relevant payment methods based on the customer’s location and other characteristics.

  • permissionsobject

    This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object. Can only be set when creating embedded or custom sessions.

    For specific permissions, please refer to their dedicated subsections, such as permissions.update_shipping_details.

    • permissions.update_shipping_detailsenum

      Determines which entity is allowed to update the shipping details.

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

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

      Possible enum values
      client_only

      The field of the CheckoutSession can only be updated by the client via the publishable key.

      server_only

      The field of the CheckoutSession can only be updated by the server via the secret key.

  • phone_number_collectionobject

    Controls phone number collection settings for the session.

    We recommend that you review your privacy policy and check with your legal contacts before using this feature. Learn more about collecting phone numbers with Checkout.

    • phone_number_collection.enabledbooleanRequired

      Set to true to enable phone number collection.

      Can only be set in payment and subscription mode.

  • redirect_on_completionenum

    This parameter applies to ui_mode: embedded. Learn more about the redirect behavior of embedded sessions. Defaults to always.

    Possible enum values
    always

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

    if_required

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

    never

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

  • saved_payment_method_optionsobject

    Controls saved payment method settings for the session. Only available in payment and subscription mode.

    • saved_payment_method_options.allow_redisplay_filtersarray of enums

      Uses the allow_redisplay value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout.

      Possible enum values
      always

      Use always to indicate that this payment method can always be shown to a customer in a checkout flow.

      limited

      Use limited to indicate that this payment method can’t always be shown to a customer in a checkout flow. For example, it can only be shown in the context of a specific subscription.

      unspecified

      This is the default value for payment methods where allow_redisplay wasn’t set.

    • saved_payment_method_options.payment_method_removeenum

      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_saveenum

      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_dataobject

    A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in setup mode.

    • setup_intent_data.descriptionstring

      An arbitrary string attached to the object. Often useful for displaying to users.

    • setup_intent_data.metadataobject

      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    • setup_intent_data.on_behalf_ofstringConnect only

      The Stripe account for which the setup is intended.

  • shipping_address_collectionobject

    When set, provides configuration for Checkout to collect a shipping address from a customer.

    • shipping_address_collection.allowed_countriesarray of enumsRequired

      An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations.

      Possible enum values
      AC
      AD
      AE
      AF
      AG
      AI
      AL
      AM
      AO
      AQ
      Show 228 more

  • shipping_optionsarray of objects

    The shipping rate options to apply to this Session. Up to a maximum of 5.

    • shipping_options.shipping_ratestringRequired unless shipping_rate_data is provided

      The ID of the Shipping Rate to use for this shipping option.

    • shipping_options.shipping_rate_dataobjectRequired unless shipping_rate is provided

      Parameters to be passed to Shipping Rate creation for this shipping option.

      • shipping_options.shipping_rate_data.display_namestringRequired

        The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.

      • shipping_options.shipping_rate_data.delivery_estimateobject

        The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.

        • shipping_options.shipping_rate_data.delivery_estimate.maximumobject

          The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.

          • shipping_options.shipping_rate_data.delivery_estimate.maximum.unitenumRequired

            A unit of time.

            Possible enum values
            business_day

            The delivery estimate is in business days.

            day

            The delivery estimate is in days.

            hour

            The delivery estimate is in hours.

            month

            The delivery estimate is in months.

            week

            The delivery estimate is in weeks.

          • shipping_options.shipping_rate_data.delivery_estimate.maximum.valueintegerRequired

            Must be greater than 0.

        • shipping_options.shipping_rate_data.delivery_estimate.minimumobject

          The lower bound of the estimated range. If empty, represents no lower bound.

          • shipping_options.shipping_rate_data.delivery_estimate.minimum.unitenumRequired

            A unit of time.

            Possible enum values
            business_day

            The delivery estimate is in business days.

            day

            The delivery estimate is in days.

            hour

            The delivery estimate is in hours.

            month

            The delivery estimate is in months.

            week

            The delivery estimate is in weeks.

          • shipping_options.shipping_rate_data.delivery_estimate.minimum.valueintegerRequired

            Must be greater than 0.

      • shipping_options.shipping_rate_data.fixed_amountobject

        Describes a fixed amount to charge for shipping. Must be present if type is fixed_amount.

        • shipping_options.shipping_rate_data.fixed_amount.amountintegerRequired

          A non-negative integer in cents representing how much to charge.

        • shipping_options.shipping_rate_data.fixed_amount.currencyenumRequired

          Three-letter ISO currency code, in lowercase. Must be a supported currency.

        • shipping_options.shipping_rate_data.fixed_amount.currency_optionsobject

          Shipping rates defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.

          • shipping_options.shipping_rate_data.fixed_amount.currency_options.<currency>.amountintegerRequired

            A non-negative integer in cents representing how much to charge.

          • shipping_options.shipping_rate_data.fixed_amount.currency_options.<currency>.tax_behaviorenumRecommended if calculating taxes

            Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.

            Possible enum values
            exclusive
            inclusive
            unspecified

      • shipping_options.shipping_rate_data.metadataobject

        Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

      • shipping_options.shipping_rate_data.tax_behaviorenumRecommended if calculating taxes

        Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.

        Possible enum values
        exclusive
        inclusive
        unspecified

      • shipping_options.shipping_rate_data.tax_codestringRecommended if calculating taxes

        A tax code ID. The Shipping tax code is txcd_92010001.

      • shipping_options.shipping_rate_data.typeenumRequired

        The type of calculation to use on the shipping rate.

        Possible enum values
        fixed_amount

        The shipping rate is a fixed amount.

  • submit_typeenum

    Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the submit button. submit_type can only be specified on Checkout Sessions in payment or subscription mode. If blank or auto, pay is used.

    Possible enum values
    auto

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

    book

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

    donate

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

    pay

    Submit button includes a ‘Buy’ label

    subscribe

    Submit button includes a ‘Subscribe’ label

  • subscription_dataobject

    A subset of parameters to be passed to subscription creation for Checkout Sessions in subscription mode.

    • subscription_data.application_fee_percentfloatConnect only

      A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner’s Stripe account. To use an application fee percent, the request must be made on behalf of another account, using the Stripe-Account header or an OAuth key. For more information, see the application fees documentation.

    • subscription_data.billing_cycle_anchortimestamp

      A future timestamp to anchor the subscription’s billing cycle for new subscriptions.

    • subscription_data.billing_modeobject

      Controls how prorations and invoices for subscriptions are calculated and orchestrated.

      • subscription_data.billing_mode.typeenumRequired

        Controls the calculation and orchestration of prorations and invoices for subscriptions.

        Possible enum values
        classic

        Calculations for subscriptions and invoices are based on legacy defaults.

        flexible

        Supports more flexible calculation and orchestration options for subscriptions and invoices.

    • subscription_data.default_tax_ratesarray of strings

      The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.

    • subscription_data.descriptionstring

      The subscription’s description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in the customer portal.

    • subscription_data.invoice_settingsobject

      All invoices will be billed using the specified settings.

      • subscription_data.invoice_settings.issuerobjectConnect only

        The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.

        • subscription_data.invoice_settings.issuer.typeenumRequired

          Type of the account referenced in the request.

          Possible enum values
          account

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

          self

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

        • subscription_data.invoice_settings.issuer.accountstringRequired only if type is account

          The connected account being referenced when type is account.

    • subscription_data.metadataobject

      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    • subscription_data.on_behalf_ofstring

      The account on behalf of which to charge, for each of the subscription’s invoices.

    • subscription_data.proration_behaviorenum

      Determines how to handle prorations resulting from the billing_cycle_anchor. If no value is passed, the default is create_prorations.

      Possible enum values
      create_prorations

      Will cause proration invoice items to be created when applicable.

      none

      Disable creating prorations in current Checkout Session

    • subscription_data.transfer_dataobjectConnect only

      If specified, the funds from the subscription’s invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.

      • subscription_data.transfer_data.destinationstringRequired

        ID of an existing, connected Stripe account.

      • subscription_data.transfer_data.amount_percentfloat

        A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.

    • subscription_data.trial_endinteger

      Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48 hours in the future.

    • subscription_data.trial_period_daysinteger

      Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.

    • subscription_data.trial_settingsobject

      Settings related to subscription trials.

      • subscription_data.trial_settings.end_behaviorobjectRequired

        Defines how the subscription should behave when the user’s free trial ends.

        • subscription_data.trial_settings.end_behavior.missing_payment_methodenumRequired

          Indicates how the subscription should change when the trial ends if the user did not provide a payment method.

          Possible enum values
          cancel

          Cancel the subscription if a payment method is not attached when the trial ends.

          create_invoice

          Create an invoice when the trial ends, even if the user did not set up a payment method.

          pause

          Pause the subscription if a payment method is not attached when the trial ends.

  • tax_id_collectionobject

    Controls tax ID collection during checkout.

    • tax_id_collection.enabledbooleanRequired

      Enable tax ID collection during checkout. Defaults to false.

    • tax_id_collection.requiredenum

      Describes whether a tax ID is required during checkout. Defaults to never.

      Possible enum values
      if_supported

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

      never

      Tax ID collection is never required.

  • wallet_optionsobject

    Wallet-specific configuration.

    • wallet_options.linkobject

      contains details about the Link wallet options.

      • wallet_options.link.displayenum

        Specifies whether Checkout should display Link as a payment option. By default, Checkout will display all the supported wallets that the Checkout Session was created with. This is the auto behavior, and it is the default choice.

        Possible enum values
        auto

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

        never

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

Returns

Returns a Checkout Session object.

POST /v1/checkout/sessions
curl https://api.stripe.com/v1/checkout/sessions \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  --data-urlencode success_url="https://example.com/success" \
  -d "line_items[0][price]"=price_1MotwRLkdIwHu7ixYcPLm5uZ \
  -d "line_items[0][quantity]"=2 \
  -d mode=payment
Response
{
  "id": "cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u",
  "object": "checkout.session",
  "after_expiration": null,
  "allow_promotion_codes": null,
  "amount_subtotal": 2198,
  "amount_total": 2198,
  "automatic_tax": {
    "enabled": false,
    "liability": null,
    "status": null
  },
  "billing_address_collection": null,
  "cancel_url": null,
  "client_reference_id": null,
  "consent": null,
  "consent_collection": null,
  "created": 1679600215,
  "currency": "usd",
  "custom_fields": [],
  "custom_text": {
    "shipping_address": null,
    "submit": null
  },
  "customer": null,
  "customer_creation": "if_required",
  "customer_details": null,
  "customer_email": null,
  "expires_at": 1679686615,
  "invoice": null,
  "invoice_creation": {
    "enabled": false,
    "invoice_data": {
      "account_tax_ids": null,
      "custom_fields": null,
      "description": null,
      "footer": null,
      "issuer": null,
      "metadata": {},
      "rendering_options": null
    }
  },
  "livemode": false,
  "locale": null,
  "metadata": {},
  "mode": "payment",
  "payment_intent": null,
  "payment_link": null,
  "payment_method_collection": "always",
  "payment_method_options": {},
  "payment_method_types": [
    "card"
  ],
  "payment_status": "unpaid",
  "phone_number_collection": {
    "enabled": false
  },
  "recovered_from": null,
  "setup_intent": null,
  "shipping_address_collection": null,
  "shipping_cost": null,
  "shipping_details": null,
  "shipping_options": [],
  "status": "open",
  "submit_type": null,
  "subscription": null,
  "success_url": "https://example.com/success",
  "total_details": {
    "amount_discount": 0,
    "amount_shipping": 0,
    "amount_tax": 0
  },
  "url": "https://checkout.stripe.com/c/pay/cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u#fidkdWxOYHwnPyd1blpxYHZxWjA0SDdPUW5JbmFMck1wMmx9N2BLZjFEfGRUNWhqTmJ%2FM2F8bUA2SDRySkFdUV81T1BSV0YxcWJcTUJcYW5rSzN3dzBLPUE0TzRKTTxzNFBjPWZEX1NKSkxpNTVjRjN8VHE0YicpJ2N3amhWYHdzYHcnP3F3cGApJ2lkfGpwcVF8dWAnPyd2bGtiaWBabHFgaCcpJ2BrZGdpYFVpZGZgbWppYWB3dic%2FcXdwYHgl"
}