Stripe · Schema

PostCheckoutSessionsRequest

CommerceFinancial ServicesFintechPaymentsT1StripeAgentic CommercePoint-of-SalePayment Processing

Properties

Name Type Description
after_expiration object Configure actions after a Checkout Session has expired.
allow_promotion_codes boolean Enables user redeemable promotion codes.
automatic_tax object Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
billing_address_collection string Specify whether Checkout should collect the customer's billing address.
cancel_url string If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.
client_reference_id string A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the session with your internal systems.
consent_collection object Configure fields for the Checkout Session to gather active consent from customers.
currency string Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Required in `setup` mode when `pay
custom_fields array Collect additional information from your customer using custom fields. Up to 2 fields are supported.
custom_text object Display additional text for your customers using custom text.
customer string 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 C
customer_creation string Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation. When a Customer is not created, you can still retrieve email, address, and
customer_email string 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 alre
customer_update object Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.
discounts array The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
expand array Specifies which fields in the response should be expanded.
expires_at integer The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation.
invoice_creation object Generate a post-purchase Invoice for one-time payments.
line_items array A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices). For `payment` mode, there is a maximum of 100 line items, how
locale string The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
metadata object Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individu
mode string The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.
payment_intent_data object A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
payment_method_collection string 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
payment_method_configuration string The ID of the payment method configuration to use with this Checkout session.
payment_method_options object Payment-method-specific configuration.
payment_method_types array A list of the types of payment methods (e.g., `card`) this Checkout Session can accept. You can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.
phone_number_collection object 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 p
redirect_on_completion string This parameter applies to `ui_mode: embedded`. By default, Stripe will always redirect to your return_url after a successful confirmation. If you set `redirect_on_completion: 'if_required'`, then we w
return_url string 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` and redirect-based pa
setup_intent_data object A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.
shipping_address_collection object When set, provides configuration for Checkout to collect a shipping address from a customer.
shipping_options array The shipping rate options to apply to this Session. Up to a maximum of 5.
submit_type string 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 `p
subscription_data object A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
success_url string The URL to which Stripe should send customers when payment or setup is complete. This parameter is not allowed if ui_mode is `embedded`. If you’d like to use information from the successful Checkout S
tax_id_collection object Controls tax ID collection settings for the session.
ui_mode string `ui_mode` can be `hosted` or `embedded`. The default is `hosted`.
View JSON Schema on GitHub

JSON Schema

stripe-post-checkout-sessions-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/stripe/main/json-schema/stripe-post-checkout-sessions-request-schema.json",
  "title": "PostCheckoutSessionsRequest",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/stripe-checkout-api-openapi.yml#/components/schemas/PostCheckoutSessionsRequest",
  "type": "object",
  "properties": {
    "after_expiration": {
      "description": "Configure actions after a Checkout Session has expired.",
      "properties": {
        "recovery": {
          "properties": {
            "allow_promotion_codes": {
              "type": "boolean"
            },
            "enabled": {
              "type": "boolean"
            }
          },
          "required": [
            "enabled"
          ],
          "title": "recovery_params",
          "type": "object"
        }
      },
      "title": "after_expiration_params",
      "type": "object"
    },
    "allow_promotion_codes": {
      "description": "Enables user redeemable promotion codes.",
      "type": "boolean"
    },
    "automatic_tax": {
      "description": "Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.",
      "properties": {
        "enabled": {
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "title": "automatic_tax_params",
      "type": "object"
    },
    "billing_address_collection": {
      "description": "Specify whether Checkout should collect the customer's billing address.",
      "enum": [
        "auto",
        "required"
      ],
      "type": "string"
    },
    "cancel_url": {
      "description": "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.",
      "maxLength": 5000,
      "type": "string"
    },
    "client_reference_id": {
      "description": "A unique string to reference the Checkout Session. This can be a\ncustomer ID, a cart ID, or similar, and can be used to reconcile the\nsession with your internal systems.",
      "maxLength": 200,
      "type": "string"
    },
    "consent_collection": {
      "description": "Configure fields for the Checkout Session to gather active consent from customers.",
      "properties": {
        "payment_method_reuse_agreement": {
          "properties": {
            "position": {
              "enum": [
                "auto",
                "hidden"
              ],
              "type": "string"
            }
          },
          "required": [
            "position"
          ],
          "title": "payment_method_reuse_agreement_params",
          "type": "object"
        },
        "promotions": {
          "enum": [
            "auto",
            "none"
          ],
          "type": "string"
        },
        "terms_of_service": {
          "enum": [
            "none",
            "required"
          ],
          "type": "string"
        }
      },
      "title": "consent_collection_params",
      "type": "object"
    },
    "currency": {
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Required in `setup` mode when `payment_method_types` is not set.",
      "type": "string"
    },
    "custom_fields": {
      "description": "Collect additional information from your customer using custom fields. Up to 2 fields are supported.",
      "items": {
        "properties": {
          "dropdown": {
            "properties": {
              "options": {
                "items": {
                  "properties": {
                    "label": {
                      "maxLength": 100,
                      "type": "string"
                    },
                    "value": {
                      "maxLength": 100,
                      "type": "string"
                    }
                  },
                  "required": [
                    "label",
                    "value"
                  ],
                  "title": "custom_field_option_param",
                  "type": "object"
                },
                "type": "array"
              }
            },
            "required": [
              "options"
            ],
            "title": "custom_field_dropdown_param",
            "type": "object"
          },
          "key": {
            "maxLength": 200,
            "type": "string"
          },
          "label": {
            "properties": {
              "custom": {
                "maxLength": 50,
                "type": "string"
              },
              "type": {
                "enum": [
                  "custom"
                ],
                "type": "string"
              }
            },
            "required": [
              "custom",
              "type"
            ],
            "title": "custom_field_label_param",
            "type": "object"
          },
          "numeric": {
            "properties": {
              "maximum_length": {
                "type": "integer"
              },
              "minimum_length": {
                "type": "integer"
              }
            },
            "title": "custom_field_numeric_param",
            "type": "object"
          },
          "optional": {
            "type": "boolean"
          },
          "text": {
            "properties": {
              "maximum_length": {
                "type": "integer"
              },
              "minimum_length": {
                "type": "integer"
              }
            },
            "title": "custom_field_text_param",
            "type": "object"
          },
          "type": {
            "enum": [
              "dropdown",
              "numeric",
              "text"
            ],
            "type": "string"
          }
        },
        "required": [
          "key",
          "label",
          "type"
        ],
        "title": "custom_field_param",
        "type": "object"
      },
      "type": "array"
    },
    "custom_text": {
      "description": "Display additional text for your customers using custom text.",
      "properties": {
        "after_submit": {
          "anyOf": [
            {
              "properties": {
                "message": {
                  "maxLength": 1200,
                  "type": "string"
                }
              },
              "required": [
                "message"
              ],
              "title": "custom_text_position_param",
              "type": "object"
            },
            {
              "enum": [
                ""
              ],
              "type": "string"
            }
          ]
        },
        "shipping_address": {
          "anyOf": [
            {
              "properties": {
                "message": {
                  "maxLength": 1200,
                  "type": "string"
                }
              },
              "required": [
                "message"
              ],
              "title": "custom_text_position_param",
              "type": "object"
            },
            {
              "enum": [
                ""
              ],
              "type": "string"
            }
          ]
        },
        "submit": {
          "anyOf": [
            {
              "properties": {
                "message": {
                  "maxLength": 1200,
                  "type": "string"
                }
              },
              "required": [
                "message"
              ],
              "title": "custom_text_position_param",
              "type": "object"
            },
            {
              "enum": [
                ""
              ],
              "type": "string"
            }
          ]
        },
        "terms_of_service_acceptance": {
          "anyOf": [
            {
              "properties": {
                "message": {
                  "maxLength": 1200,
                  "type": "string"
                }
              },
              "required": [
                "message"
              ],
              "title": "custom_text_position_param",
              "type": "object"
            },
            {
              "enum": [
                ""
              ],
              "type": "string"
            }
          ]
        }
      },
      "title": "custom_text_param",
      "type": "object"
    },
    "customer": {
      "description": "ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card\npayment method will be used to prefill the email, name, card details, and billing address\non the Checkout page. In `subscription` mode, the customer’s [default payment method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method)\nwill 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.\n\nIf the Customer already has a valid [email](https://stripe.com/docs/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout.\nIf the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.\n\nIf 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.\n\nYou can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.",
      "maxLength": 5000,
      "type": "string"
    },
    "customer_creation": {
      "description": "Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation.\n\nWhen a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout\nwith [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details).\n\nSessions that don't create Customers instead are grouped by [guest customers](https://stripe.com/docs/payments/checkout/guest-customers)\nin the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.\n\nCan only be set in `payment` and `setup` mode.",
      "enum": [
        "always",
        "if_required"
      ],
      "type": "string"
    },
    "customer_email": {
      "description": "If provided, this value will be used when the Customer object is created.\nIf not provided, customers will be asked to enter their email address.\nUse this parameter to prefill customer data if you already have an email\non file. To access information about the customer once a session is\ncomplete, use the `customer` field.",
      "type": "string"
    },
    "customer_update": {
      "description": "Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.",
      "properties": {
        "address": {
          "enum": [
            "auto",
            "never"
          ],
          "type": "string",
          "x-stripeBypassValidation": true
        },
        "name": {
          "enum": [
            "auto",
            "never"
          ],
          "type": "string",
          "x-stripeBypassValidation": true
        },
        "shipping": {
          "enum": [
            "auto",
            "never"
          ],
          "type": "string",
          "x-stripeBypassValidation": true
        }
      },
      "title": "customer_update_params",
      "type": "object"
    },
    "discounts": {
      "description": "The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.",
      "items": {
        "properties": {
          "coupon": {
            "maxLength": 5000,
            "type": "string"
          },
          "promotion_code": {
            "maxLength": 5000,
            "type": "string"
          }
        },
        "title": "discount_params",
        "type": "object"
      },
      "type": "array"
    },
    "expand": {
      "description": "Specifies which fields in the response should be expanded.",
      "items": {
        "maxLength": 5000,
        "type": "string"
      },
      "type": "array"
    },
    "expires_at": {
      "description": "The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation.",
      "format": "unix-time",
      "type": "integer"
    },
    "invoice_creation": {
      "description": "Generate a post-purchase Invoice for one-time payments.",
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "invoice_data": {
          "properties": {
            "account_tax_ids": {
              "anyOf": [
                {
                  "items": {
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "type": "array"
                },
                {
                  "enum": [
                    ""
                  ],
                  "type": "string"
                }
              ]
            },
            "custom_fields": {
              "anyOf": [
                {
                  "items": {
                    "properties": {
                      "name": {
                        "maxLength": 30,
                        "type": "string"
                      },
                      "value": {
                        "maxLength": 30,
                        "type": "string"
                      }
                    },
                    "required": [
                      "name",
                      "value"
                    ],
                    "title": "custom_field_params",
                    "type": "object"
                  },
                  "type": "array"
                },
                {
                  "enum": [
                    ""
                  ],
                  "type": "string"
                }
              ]
            },
            "description": {
              "maxLength": 1500,
              "type": "string"
            },
            "footer": {
              "maxLength": 5000,
              "type": "string"
            },
            "metadata": {
              "additionalProperties": {
                "type": "string"
              },
              "type": "object"
            },
            "rendering_options": {
              "anyOf": [
                {
                  "properties": {
                    "amount_tax_display": {
                      "enum": [
                        "",
                        "exclude_tax",
                        "include_inclusive_tax"
                      ],
                      "type": "string"
                    }
                  },
                  "title": "rendering_options_param",
                  "type": "object"
                },
                {
                  "enum": [
                    ""
                  ],
                  "type": "string"
                }
              ]
            }
          },
          "title": "invoice_data_params",
          "type": "object"
        }
      },
      "required": [
        "enabled"
      ],
      "title": "invoice_creation_params",
      "type": "object"
    },
    "line_items": {
      "description": "A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).\n\nFor `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.\n\nFor `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.",
      "items": {
        "properties": {
          "adjustable_quantity": {
            "properties": {
              "enabled": {
                "type": "boolean"
              },
              "maximum": {
                "type": "integer"
              },
              "minimum": {
                "type": "integer"
              }
            },
            "required": [
              "enabled"
            ],
            "title": "adjustable_quantity_params",
            "type": "object"
          },
          "dynamic_tax_rates": {
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          },
          "price": {
            "maxLength": 5000,
            "type": "string"
          },
          "price_data": {
            "properties": {
              "currency": {
                "type": "string"
              },
              "product": {
                "maxLength": 5000,
                "type": "string"
              },
              "product_data": {
                "properties": {
                  "description": {
                    "maxLength": 40000,
                    "type": "string"
                  },
                  "images": {
                    "items": {
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "metadata": {
                    "additionalProperties": {
                      "type": "string"
                    },
                    "type": "object"
                  },
                  "name": {
                    "maxLength": 5000,
                    "type": "string"
                  },
                  "tax_code": {
                    "maxLength": 5000,
                    "type": "string"
                  }
                },
                "required": [
                  "name"
                ],
                "title": "product_data",
                "type": "object"
              },
              "recurring": {
                "properties": {
                  "interval": {
                    "enum": [
                      "day",
                      "month",
                      "week",
                      "year"
                    ],
                    "type": "string"
                  },
                  "interval_count": {
                    "type": "integer"
                  }
                },
                "required": [
                  "interval"
                ],
                "title": "recurring_adhoc",
                "type": "object"
              },
              "tax_behavior": {
                "enum": [
                  "exclusive",
                  "inclusive",
                  "unspecified"
                ],
                "type": "string"
              },
              "unit_amount": {
                "type": "integer"
              },
              "unit_amount_decimal": {
                "format": "decimal",
                "type": "string"
              }
            },
            "required": [
              "currency"
            ],
            "title": "price_data_with_product_data",
            "type": "object"
          },
          "quantity": {
            "type": "integer"
          },
          "tax_rates": {
            "items": {
              "maxLength": 5000,
              "type": "string"
            },
            "type": "array"
          }
        },
        "title": "line_item_params",
        "type": "object"
      },
      "type": "array"
    },
    "locale": {
      "description": "The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.",
      "enum": [
        "auto",
        "bg",
        "cs",
        "da",
        "de",
        "el",
        "en",
        "en-GB",
        "es",
        "es-419",
        "et",
        "fi",
        "fil",
        "fr",
        "fr-CA",
        "hr",
        "hu",
        "id",
        "it",
        "ja",
        "ko",
        "lt",
        "lv",
        "ms",
        "mt",
        "nb",
        "nl",
        "pl",
        "pt",
        "pt-BR",
        "ro",
        "ru",
        "sk",
        "sl",
        "sv",
        "th",
        "tr",
        "vi",
        "zh",
        "zh-HK",
        "zh-TW"
      ],
      "type": "string",
      "x-stripeBypassValidation": true
    },
    "metadata": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.",
      "type": "object"
    },
    "mode": {
      "description": "The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.",
      "enum": [
        "payment",
        "setup",
        "subscription"
      ],
      "type": "string"
    },
    "payment_intent_data": {
      "description": "A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.",
      "properties": {
        "application_fee_amount": {
          "type": "integer"
        },
        "capture_method": {
          "enum": [
            "automatic",
            "automatic_async",
            "manual"
          ],
          "type": "string"
        },
        "description": {
          "maxLength": 1000,
          "type": "string"
        },
        "metadata": {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object"
        },
        "on_behalf_of": {
          "type": "string"
        },
        "receipt_email": {
          "type": "string"
        },
        "setup_future_usage": {
          "enum": [
            "off_session",
            "on_session"
          ],
          "type": "string"
        },
        "shipping": {
          "properties": {
            "address": {
              "properties": {
                "city": {
                  "maxLength": 5000,
                  "type": "string"
                },
                "country": {
                  "maxLength": 5000,
                  "type": "string"
                },
                "line1": {
                  "maxLength": 5000,
                  "type": "string"
                },
                "line2": {
                  "maxLength": 5000,
                  "type": "string"
                },
                "postal_code": {
                  "maxLength": 5000,
                  "type": "string"
                },
                "state": {
                  "maxLength": 5000,
                  "type": "string"
                }
              },
              "required": [
                "line1"
              ],
              "title": "address",
              "type": "object"
            },
            "carrier": {
              "maxLength": 5000,
              "type": "string"
            },
            "name": {
              "maxLength": 5000,
              "type": "string"
            },
            "phone": {
              "maxLength": 5000,
              "type": "string"
            },
            "tracking_number": {
              "maxLength": 5000,
              "type": "string"
            }
          },
          "required": [
            "address",
            "name"
          ],
          "title": "shipping",
          "type": "object"
        },
        "statement_descriptor": {
          "maxLength": 22,
          "type": "string"
        },
        "statement_descriptor_suffix": {
          "maxLength": 22,
          "type": "string"
        },
        "transfer_data": {
          "properties": {
            "amount": {
              "type": "integer"
            },
            "destination": {
              "type": "string"
            }
          },
          "required": [
            "destination"
          ],
          "title": "transfer_data_params",
          "type": "object"
        },
        "transfer_group": {
          "type": "string"
        }
      },
      "title": "payment_intent_data_params",
      "type": "object"
    },
    "payment_method_collection": {
      "description": "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.\nThis may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).",
      "enum": [
        "always",
        "if_required"
      ],
      "type": "string"
    },
    "payment_method_configuration": {
      "description": "The ID of the payment method configuration to use with this Checkout session.",
      "maxLength": 100,
      "type": "string"
    },
    "payment_method_options": {
      "description": "Payment-method-specific configuration.",
      "properties": {
        "acss_debit": {
          "properties": {
            "currency": {
              "enum": [
                "cad",
                "usd"
              ],
              "type": "string"
            },
            "mandate_options": {
              "properties": {
                "custom_mandate_url": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "enum": [
                        ""
                      ],
                      "type": "string"
                    }
                  ]
                },
                "default_for": {
                  "items": {
                    "enum": [
                      "invoice",
                      "subscription"
                    ],
                    "type": "string"
                  },
                  "type": "array"
                },
                "interval_description": {
                  "maxLength": 500,
                  "type": "string"
                },
                "payment_schedule": {
                  "enum": [
                    "combined",
                    "interval",
                    "sporadic"
                  ],
                  "type": "string"
                },
                "transaction_type": {
                  "enum": [
                    "business",
                    "personal"
                  ],
                  "type": "string"
                }
              },
              "title": "mandate_options_param",
              "type": "object"
            },
            "setup_future_usage": {
              "enum": [
                "none",
                "off_session",
                "on_session"
              ],
              "type": "string"
            },
            "verification_method": {
              "enum": [
                "automatic",
                "instant",
                "microdeposits"
              ],
              "type": "string",
              "x-stripeBypassValidation": true
            }
          },
          "title": "payment_method_options_param",
          "type": "object"
        },
        "affirm": {
          "properties": {
            "setup_future_usage": {
              "enum": [
                "none"
              ],
              "type": "string"
            }
          },
          "title": "payment_method_options_param",
          "type": "object"
        },
        "afterpay_clearpay": {
          "properties": {
            "setup_future_usage": {
              "enum": [
                "none"
              ],
              "type": "string"
            }
          },
          "title": "payment_method_options_param",
          "type": "object"
        },
        "alipay": {
          "properties": {
            "setup_future_usage": {
              "enum": [
                "none"
              ],
              "type": "string"
            }
          },
          "title": "payment_method_options_param",
          "type": "object"
        },
        "au_becs_debit": {
          "properties": {
            "setup_future_usage": {
              "enum": [
                "none"
              ],
              "type": "string"
            }
          },
          "title": "payment_method_options_param",
          "type": "object"
        },
        "bacs_debit": {
          "properties": {
            "setup_future_usage": {
              "enum": [
                "none",
                "off_session",
                "on_session"
              ],
              "type": "string"
            }
          },
          "title": "payment_method_options_param",
          "type": "object"
        },
        "bancontact": {
          "properties": {
            "setup_future_usage": {
              "enum": [
                "none"
              ],
              "type": "string"
            }
          },
          "title": "payment_method_options_param",
          "type": "object"
        },
        "boleto": {
          "properties": {
            "expires_after_days": {
              "type": "integer"
            },
            "setup_future_usage": {
              "enum": [
                "none",
                "off_session",
                "on_session"
              ],
              "type": "string"
            }
          },
          "title": "payment_method_options_param",
          "type": "object"
        },
        "card": {
          "properties": {
            "installments": {
              "properties": {
                "enabled": {
                  "type": "boolean"
                }
              },
              "title": "installments_param",
              "type": "object"
            },
            "setup_future_usage": {
              "enum": [
                "off_session",
                "on_session"
              ],
              "type": "string"
            },
            "statement_descriptor_suffix_kana": {
              "maxLength": 22,
              "type": "string"
            },
            "statement_descriptor_suffix_kanji": {
              "maxLength": 17,
              "type": "string"
            }
          },
          "title": "payment_method_options_param",
          "type": "object"
        },
        "cashapp": {
          "properties": {
            "setup_future_usage": {
              "enum": [
                "none",
                "off_session",
                "on_session"
              ],
              "type": "string"
            }
          },
          "title": "payment_method_options_param",
          "type": "object"
        },
        "customer_balance": {
          "properties": {
            "bank_transfer": {
              "properties": {
                "eu_bank_transfer": {
                  "properties": {
                    "country": {
                      "maxLength": 5000,
                      "type": "string"
                    }
                  },
                  "required": [
                    "country"
                  ],
                  "title": "eu_bank_transfer_params",
                  "type": "object"
                },
                "requested_address_types": {
                  "items": {
                    "enum": [
                      "aba",
                      "iban",
                      "sepa",
                      "sort_code",
                      "spei",
                      "swift",
                      "zengin"
                    ],
                    "type": "string",
                    "x-stripeBypassValidation": true
                  },
                  "type": "array"
                },
                "type": {
                  "enum": [
                    "eu_bank_transfer",
                    "gb_bank_transfer",
                    "jp_bank_transfer",
                    "mx_bank_transfer",
                    "us_bank_transfer"
      

# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/json-schema/stripe-post-checkout-sessions-request-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/stripe-post-checkout-sessions-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.