payment_method_us_bank_account
{
"type": "object",
"title": "payment_method_us_bank_account",
"properties": {
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last four digits of the bank account number."
},
"networks": {
"anyOf": [
{
"$ref": "#/components/schemas/us_bank_account_networks"
}
],
"nullable": true,
"description": "Contains information about US bank account networks that can be used."
},
"bank_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The name of the bank."
},
"fingerprint": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
},
"account_type": {
"enum": [
"checking",
"savings"
],
"type": "string",
"nullable": true,
"description": "Account type: checkings or savings. Defaults to checking if omitted."
},
"routing_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Routing number of the bank account."
},
"status_details": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_us_bank_account_status_details"
}
],
"nullable": true,
"description": "Contains information about the future reusability of this PaymentMethod."
},
"account_holder_type": {
"enum": [
"company",
"individual"
],
"type": "string",
"nullable": true,
"description": "Account holder type: individual or company."
},
"financial_connections_account": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The ID of the Financial Connections Account used to create the payment method."
}
},
"description": "",
"x-expandableFields": [
"networks",
"status_details"
]
}
payment_method_us_bank_account_blocked
{
"type": "object",
"title": "payment_method_us_bank_account_blocked",
"properties": {
"reason": {
"enum": [
"bank_account_closed",
"bank_account_frozen",
"bank_account_invalid_details",
"bank_account_restricted",
"bank_account_unusable",
"debit_not_authorized",
"tokenized_account_number_deactivated"
],
"type": "string",
"nullable": true,
"description": "The reason why this PaymentMethod's fingerprint has been blocked"
},
"network_code": {
"enum": [
"R02",
"R03",
"R04",
"R05",
"R07",
"R08",
"R10",
"R11",
"R16",
"R20",
"R29",
"R31"
],
"type": "string",
"nullable": true,
"description": "The ACH network code that resulted in this block."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_us_bank_account_status_details
{
"type": "object",
"title": "payment_method_us_bank_account_status_details",
"properties": {
"blocked": {
"$ref": "#/components/schemas/payment_method_us_bank_account_blocked"
}
},
"description": "",
"x-expandableFields": [
"blocked"
]
}
payment_method_wechat_pay
{
"type": "object",
"title": "payment_method_wechat_pay",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_zip
{
"type": "object",
"title": "payment_method_zip",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_pages_checkout_session_adaptive_pricing
{
"type": "object",
"title": "PaymentPagesCheckoutSessionAdaptivePricing",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "If enabled, Adaptive Pricing is available on [eligible sessions](https://docs.stripe.com/payments/currencies/localize-prices/adaptive-pricing?payment-ui=stripe-hosted#restrictions)."
}
},
"description": "",
"x-expandableFields": []
}
payment_pages_checkout_session_after_expiration
{
"type": "object",
"title": "PaymentPagesCheckoutSessionAfterExpiration",
"properties": {
"recovery": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_pages_checkout_session_after_expiration_recovery"
}
],
"nullable": true,
"description": "When set, configuration used to recover the Checkout Session on expiry."
}
},
"description": "",
"x-expandableFields": [
"recovery"
]
}
payment_pages_checkout_session_after_expiration_recovery
{
"type": "object",
"title": "PaymentPagesCheckoutSessionAfterExpirationRecovery",
"required": [
"allow_promotion_codes",
"enabled"
],
"properties": {
"url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session"
},
"enabled": {
"type": "boolean",
"description": "If `true`, a recovery url will be generated to recover this Checkout Session if it\nexpires before a transaction is completed. It will be attached to the\nCheckout Session object upon expiration."
},
"expires_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The timestamp at which the recovery URL will expire."
},
"allow_promotion_codes": {
"type": "boolean",
"description": "Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`"
}
},
"description": "",
"x-expandableFields": []
}
payment_pages_checkout_session_automatic_tax
{
"type": "object",
"title": "PaymentPagesCheckoutSessionAutomaticTax",
"required": [
"enabled"
],
"properties": {
"status": {
"enum": [
"complete",
"failed",
"requires_location_inputs"
],
"type": "string",
"nullable": true,
"description": "The status of the most recent automated tax calculation for this session."
},
"enabled": {
"type": "boolean",
"description": "Indicates whether automatic tax is enabled for the session"
},
"provider": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The tax provider powering automatic tax."
},
"liability": {
"anyOf": [
{
"$ref": "#/components/schemas/connect_account_reference"
}
],
"nullable": true,
"description": "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."
}
},
"description": "",
"x-expandableFields": [
"liability"
]
}
payment_pages_checkout_session_branding_settings
{
"type": "object",
"title": "PaymentPagesCheckoutSessionBrandingSettings",
"required": [
"background_color",
"border_style",
"button_color",
"display_name",
"font_family"
],
"properties": {
"icon": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_pages_checkout_session_branding_settings_icon"
}
],
"nullable": true,
"description": "The icon for the Checkout Session. You cannot set both `logo` and `icon`."
},
"logo": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_pages_checkout_session_branding_settings_logo"
}
],
"nullable": true,
"description": "The logo for the Checkout Session. You cannot set both `logo` and `icon`."
},
"font_family": {
"type": "string",
"maxLength": 5000,
"description": "The font family for the Checkout Session. Must be one of the [supported font families](https://docs.stripe.com/payments/checkout/customization/appearance?payment-ui=stripe-hosted#font-compatibility)."
},
"border_style": {
"enum": [
"pill",
"rectangular",
"rounded"
],
"type": "string",
"description": "The border style for the Checkout Session. Must be one of `rounded`, `rectangular`, or `pill`."
},
"button_color": {
"type": "string",
"maxLength": 5000,
"description": "A hex color value starting with `#` representing the button color for the Checkout Session."
},
"display_name": {
"type": "string",
"maxLength": 5000,
"description": "The display name shown on the Checkout Session."
},
"background_color": {
"type": "string",
"maxLength": 5000,
"description": "A hex color value starting with `#` representing the background color for the Checkout Session."
}
},
"description": "",
"x-expandableFields": [
"icon",
"logo"
]
}
payment_pages_checkout_session_branding_settings_icon
{
"type": "object",
"title": "PaymentPagesCheckoutSessionBrandingSettingsIcon",
"required": [
"type"
],
"properties": {
"url": {
"type": "string",
"maxLength": 5000,
"description": "The URL of the image. Present when `type` is `url`."
},
"file": {
"type": "string",
"maxLength": 5000,
"description": "The ID of a [File upload](https://stripe.com/docs/api/files) representing the icon. Purpose must be `business_icon`. Required if `type` is `file` and disallowed otherwise."
},
"type": {
"enum": [
"file",
"url"
],
"type": "string",
"description": "The type of image for the icon. Must be one of `file` or `url`."
}
},
"description": "",
"x-expandableFields": []
}
payment_pages_checkout_session_branding_settings_logo
{
"type": "object",
"title": "PaymentPagesCheckoutSessionBrandingSettingsLogo",
"required": [
"type"
],
"properties": {
"url": {
"type": "string",
"maxLength": 5000,
"description": "The URL of the image. Present when `type` is `url`."
},
"file": {
"type": "string",
"maxLength": 5000,
"description": "The ID of a [File upload](https://stripe.com/docs/api/files) representing the logo. Purpose must be `business_logo`. Required if `type` is `file` and disallowed otherwise."
},
"type": {
"enum": [
"file",
"url"
],
"type": "string",
"description": "The type of image for the logo. Must be one of `file` or `url`."
}
},
"description": "",
"x-expandableFields": []
}
payment_pages_checkout_session_business_name
{
"type": "object",
"title": "PaymentPagesCheckoutSessionBusinessName",
"required": [
"enabled",
"optional"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates whether business name collection is enabled for the session"
},
"optional": {
"type": "boolean",
"description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`."
}
},
"description": "",
"x-expandableFields": []
}
payment_pages_checkout_session_checkout_address_details
{
"type": "object",
"title": "PaymentPagesCheckoutSessionCheckoutAddressDetails",
"required": [
"address",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 5000,
"description": "Customer name."
},
"address": {
"$ref": "#/components/schemas/address"
}
},
"description": "",
"x-expandableFields": [
"address"
]
}
payment_pages_checkout_session_collected_information
{
"type": "object",
"title": "PaymentPagesCheckoutSessionCollectedInformation",
"properties": {
"business_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Customer’s business name for this Checkout Session"
},
"individual_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Customer’s individual name for this Checkout Session"
},
"shipping_details": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_pages_checkout_session_checkout_address_details"
}
],
"nullable": true,
"description": "Shipping information for this Checkout Session."
}
},
"description": "",
"x-expandableFields": [
"shipping_details"
]
}
payment_pages_checkout_session_consent
{
"type": "object",
"title": "PaymentPagesCheckoutSessionConsent",
"properties": {
"promotions": {
"enum": [
"opt_in",
"opt_out"
],
"type": "string",
"nullable": true,
"description": "If `opt_in`, the customer consents to receiving promotional communications\nfrom the merchant about this Checkout Session."
},
"terms_of_service": {
"enum": [
"accepted"
],
"type": "string",
"nullable": true,
"description": "If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service.",
"x-stripeBypassValidation": true
}
},
"description": "",
"x-expandableFields": []
}
payment_pages_checkout_session_consent_collection
{
"type": "object",
"title": "PaymentPagesCheckoutSessionConsentCollection",
"properties": {
"promotions": {
"enum": [
"auto",
"none"
],
"type": "string",
"nullable": true,
"description": "If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout\nSession will determine whether to display an option to opt into promotional communication\nfrom the merchant depending on the customer's locale. Only available to US merchants and US customers."
},
"terms_of_service": {
"enum": [
"none",
"required"
],
"type": "string",
"nullable": true,
"description": "If set to `required`, it requires customers to accept the terms of service before being able to pay."
},
"payment_method_reuse_agreement": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_pages_checkout_session_payment_method_reuse_agreement"
}
],
"nullable": true,
"description": "If set to `hidden`, it will hide legal text related to the reuse of a payment method."
}
},
"description": "",
"x-expandableFields": [
"payment_method_reuse_agreement"
]
}
payment_pages_checkout_session_currency_conversion
{
"type": "object",
"title": "PaymentPagesCheckoutSessionCurrencyConversion",
"required": [
"amount_subtotal",
"amount_total",
"fx_rate",
"source_currency"
],
"properties": {
"fx_rate": {
"type": "string",
"format": "decimal",
"description": "Exchange rate used to convert source currency amounts to customer currency amounts"
},
"amount_total": {
"type": "integer",
"description": "Total of all items in source currency after discounts and taxes are applied."
},
"amount_subtotal": {
"type": "integer",
"description": "Total of all items in source currency before discounts or taxes are applied."
},
"source_currency": {
"type": "string",
"maxLength": 5000,
"description": "Creation currency of the CheckoutSession before localization"
}
},
"description": "",
"x-expandableFields": []
}
payment_pages_checkout_session_custom_fields
{
"type": "object",
"title": "PaymentPagesCheckoutSessionCustomFields",
"required": [
"key",
"label",
"optional",
"type"
],
"properties": {
"key": {
"type": "string",
"maxLength": 5000,
"description": "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."
},
"text": {
"$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_text"
},
"type": {
"enum": [
"dropdown",
"numeric",
"text"
],
"type": "string",
"description": "The type of the field."
},
"label": {
"$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_label"
},
"numeric": {
"$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_numeric"
},
"dropdown": {
"$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_dropdown"
},
"optional": {
"type": "boolean",
"description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`."
}
},
"description": "",
"x-expandableFields": [
"dropdown",
"label",
"numeric",
"text"
]
}
payment_pages_checkout_session_custom_fields_dropdown
{
"type": "object",
"title": "PaymentPagesCheckoutSessionCustomFieldsDropdown",
"required": [
"options"
],
"properties": {
"value": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The option selected by the customer. This will be the `value` for the option."
},
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_option"
},
"description": "The options available for the customer to select. Up to 200 options allowed."
},
"default_value": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The value that pre-fills on the payment page."
}
},
"description": "",
"x-expandableFields": [
"options"
]
}
payment_pages_checkout_session_custom_fields_label
{
"type": "object",
"title": "PaymentPagesCheckoutSessionCustomFieldsLabel",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"custom"
],
"type": "string",
"description": "The type of the label."
},
"custom": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Custom text for the label, displayed to the customer. Up to 50 characters."
}
},
"description": "",
"x-expandableFields": []
}
payment_pages_checkout_session_custom_fields_numeric
{
"type": "object",
"title": "PaymentPagesCheckoutSessionCustomFieldsNumeric",
"properties": {
"value": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The value entered by the customer, containing only digits."
},
"default_value": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The value that pre-fills the field on the payment page."
},
"maximum_length": {
"type": "integer",
"nullable": true,
"description": "The maximum character length constraint for the customer's input."
},
"minimum_length": {
"type": "integer",
"nullable": true,
"description": "The minimum character length requirement for the customer's input."
}
},
"description": "",
"x-expandableFields": []
}
payment_pages_checkout_session_custom_fields_option
{
"type": "object",
"title": "PaymentPagesCheckoutSessionCustomFieldsOption",
"required": [
"label",
"value"
],
"properties": {
"label": {
"type": "string",
"maxLength": 5000,
"description": "The label for the option, displayed to the customer. Up to 100 characters."
},
"value": {
"type": "string",
"maxLength": 5000,
"description": "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."
}
},
"description": "",
"x-expandableFields": []
}
payment_pages_checkout_session_custom_fields_text
{
"type": "object",
"title": "PaymentPagesCheckoutSessionCustomFieldsText",
"properties": {
"value": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The value entered by the customer."
},
"default_value": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The value that pre-fills the field on the payment page."
},
"maximum_length": {
"type": "integer",
"nullable": true,
"description": "The maximum character length constraint for the customer's input."
},
"minimum_length": {
"type": "integer",
"nullable": true,
"description": "The minimum character length requirement for the customer's input."
}
},
"description": "",
"x-expandableFields": []
}
payment_pages_checkout_session_custom_text
{
"type": "object",
"title": "PaymentPagesCheckoutSessionCustomText",
"properties": {
"submit": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_pages_checkout_session_custom_text_position"
}
],
"nullable": true,
"description": "Custom text that should be displayed alongside the payment confirmation button."
},
"after_submit": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_pages_checkout_session_custom_text_position"
}
],
"nullable": true,
"description": "Custom text that should be displayed after the payment confirmation button."
},
"shipping_address": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_pages_checkout_session_custom_text_position"
}
],
"nullable": true,
"description": "Custom text that should be displayed alongside shipping address collection."
},
"terms_of_service_acceptance": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_pages_checkout_session_custom_text_position"
}
],
"nullable": true,
"description": "Custom text that should be displayed in place of the default terms of service agreement text."
}
},
"description": "",
"x-expandableFields": [
"after_submit",
"shipping_address",
"submit",
"terms_of_service_acceptance"
]
}
payment_pages_checkout_session_custom_text_position
{
"type": "object",
"title": "PaymentPagesCheckoutSessionCustomTextPosition",
"required": [
"message"
],
"properties": {
"message": {
"type": "string",
"maxLength": 1200,
"description": "Text can be up to 1200 characters in length."
}
},
"description": "",
"x-expandableFields": []
}
payment_pages_checkout_session_customer_details
{
"type": "object",
"title": "PaymentPagesCheckoutSessionCustomerDetails",
"properties": {
"name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022."
},
"email": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry.\nOtherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form."
},
"phone": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The customer's phone number after a completed Checkout Session."
},
"address": {
"anyOf": [
{
"$ref": "#/components/schemas/address"
}
],
"nullable": true,
"description": "The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022."
},
"tax_ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payment_pages_checkout_session_tax_id"
},
"nullable": true,
"description": "The customer’s tax IDs after a completed Checkout Session."
},
"tax_exempt": {
"enum": [
"exempt",
"none",
"reverse"
],
"type": "string",
"nullable": true,
"description": "The customer’s tax exempt status after a completed Checkout Session."
},
"business_name": {
"type": "string",
"nullable": true,
"maxLength": 150,
"description": "The customer's business name after a completed Checkout Session."
},
"individual_name": {
"type": "string",
"nullable": true,
"maxLength": 150,
"description": "The customer's individual name after a completed Checkout Session."
}
},
"description": "",
"x-expandableFields": [
"address",
"tax_ids"
]
}
payment_pages_checkout_session_discount
{
"type": "object",
"title": "PaymentPagesCheckoutSessionDiscount",
"properties": {
"coupon": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/coupon"
}
],
"nullable": true,
"description": "Coupon attached to the Checkout Session.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/coupon"
}
]
}
},
"promotion_code": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/promotion_code"
}
],
"nullable": true,
"description": "Promotion code attached to the Checkout Session.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/promotion_code"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"coupon",
"promotion_code"
]
}
payment_pages_checkout_session_individual_name
{
"type": "object",
"title": "PaymentPagesCheckoutSessionIndividualName",
"required": [
"enabled",
"optional"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates whether individual name collection is enabled for the session"
},
"optional": {
"type": "boolean",
"description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`."
}
},
"description": "",
"x-expandableFields": []
}
payment_pages_checkout_session_invoice_creation
{
"type": "object",
"title": "PaymentPagesCheckoutSessionInvoiceCreation",
"required": [
"enabled",
"invoice_data"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates whether invoice creation is enabled for the Checkout Session."
},
"invoice_data": {
"$ref": "#/components/schemas/payment_pages_checkout_session_invoice_settings"
}
},
"description": "",
"x-expandableFields": [
"invoice_data"
]
}
payment_pages_checkout_session_invoice_settings
{
"type": "object",
"title": "PaymentPagesCheckoutSessionInvoiceSettings",
"properties": {
"footer": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Footer displayed on the invoice."
},
"issuer": {
"anyOf": [
{
"$ref": "#/components/schemas/connect_account_reference"
}
],
"nullable": true,
"description": "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account."
},
"metadata": {
"type": "object",
"nullable": true,
"description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An arbitrary string attached to the object. Often useful for displaying to users."
},
"custom_fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/invoice_setting_custom_field"
},
"nullable": true,
"description": "Custom fields displayed on the invoice."
},
"account_tax_ids": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/tax_id"
},
{
"$ref": "#/components/schemas/deleted_tax_id"
}
],
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/tax_id"
},
{
"$ref": "#/components/schemas/deleted_tax_id"
}
]
}
},
"nullable": true,
"description": "The account tax IDs associated with the invoice."
},
"rendering_options": {
"anyOf": [
{
"$ref": "#/components/schemas/invoice_setting_checkout_rendering_options"
}
],
"nullable": true,
"description": "Options for invoice PDF rendering."
}
},
"description": "",
"x-expandableFields": [
"account_tax_ids",
"custom_fields",
"issuer",
"rendering_options"
]
}
payment_pages_checkout_session_managed_payments
{
"type": "object",
"title": "PaymentPagesCheckoutSessionManagedPayments",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Set to `true` to enable [Managed Payments](https://docs.stripe.com/payments/managed-payments), Stripe's merchant of record solution, for this session."
}
},
"description": "",
"x-expandableFields": []
}
payment_pages_checkout_session_name_collection
{
"type": "object",
"title": "PaymentPagesCheckoutSessionNameCollection",
"properties": {
"business": {
"$ref": "#/components/schemas/payment_pages_checkout_session_business_name"
},
"individual": {
"$ref": "#/components/schemas/payment_pages_checkout_session_individual_name"
}
},
"description": "",
"x-expandableFields": [
"business",
"individual"
]
}
payment_pages_checkout_session_optional_item
{
"type": "object",
"title": "PaymentPagesCheckoutSessionOptionalItem",
"required": [
"price",
"quantity"
],
"properties": {
"price": {
"type": "string",
"maxLength": 5000
},
"quantity": {
"type": "integer"
},
"adjustable_quantity": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_pages_checkout_session_optional_item_adjustable_quantity"
}
],
"nullable": true
}
},
"description": "",
"x-expandableFields": [
"adjustable_quantity"
]
}
payment_pages_checkout_session_optional_item_adjustable_quantity
{
"type": "object",
"title": "PaymentPagesCheckoutSessionOptionalItemAdjustableQuantity",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Set to true if the quantity can be adjusted to any non-negative integer."
},
"maximum": {
"type": "integer",
"nullable": true,
"description": "The maximum quantity of this item the customer can purchase. By default this value is 99. You can specify a value up to 999999."
},
"minimum": {
"type": "integer",
"nullable": true,
"description": "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."
}
},
"description": "",
"x-expandableFields": []
}
payment_pages_checkout_session_payment_method_reuse_agreement
{
"type": "object",
"title": "PaymentPagesCheckoutSessionPaymentMethodReuseAgreement",
"required": [
"position"
],
"properties": {
"position": {
"enum": [
"auto",
"hidden"
],
"type": "string",
"description": "Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used.\n\nWhen set to `hidden`, the payment method reuse agreement text will always be hidden in the UI."
}
},
"description": "",
"x-expandableFields": []
}
payment_pages_checkout_session_permissions
{
"type": "object",
"title": "PaymentPagesCheckoutSessionPermissions",
"properties": {
"update_shipping_details": {
"enum": [
"client_only",
"server_only"
],
"type": "string",
"nullable": true,
"description": "Determines which entity is allowed to update the shipping details.\n\nDefault 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.\n\nWhen 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."
}
},
"description": "",
"x-expandableFields": []
}
payment_pages_checkout_session_phone_number_collection
{
"type": "object",
"title": "PaymentPagesCheckoutSessionPhoneNumberCollection",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates whether phone number collection is enabled for the session"
}
},
"description": "",
"x-expandableFields": []
}
payment_pages_checkout_session_saved_payment_method_options
{
"type": "object",
"title": "PaymentPagesCheckoutSessionSavedPaymentMethodOptions",
"properties": {
"payment_method_save": {
"enum": [
"disabled",
"enabled"
],
"type": "string",
"nullable": true,
"description": "Enable customers to choose if they wish to save their payment method for future use. Disabled by default."
},
"payment_method_remove": {
"enum": [
"disabled",
"enabled"
],
"type": "string",
"nullable": true,
"description": "Enable customers to choose if they wish to remove their saved payment methods. Disabled by default."
},
"allow_redisplay_filters": {
"type": "array",
"items": {
"enum": [
"always",
"limited",
"unspecified"
],
"type": "string"
},
"nullable": true,
"description": "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."
}
},
"description": "",
"x-expandableFields": []
}
payment_pages_checkout_session_shipping_address_collection
{
"type": "object",
"title": "PaymentPagesCheckoutSessionShippingAddressCollection",
"required": [
"allowed_countries"
],
"properties": {
"allowed_countries": {
"type": "array",
"items": {
"enum": [
"AC",
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AO",
"AQ",
"AR",
"AT",
"AU",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BL",
"BM",
"BN",
"BO",
"BQ",
"BR",
"BS",
"BT",
"BV",
"BW",
"BY",
"BZ",
"CA",
"CD",
"CF",
"CG",
"CH",
"CI",
"CK",
"CL",
"CM",
"CN",
"CO",
"CR",
"CV",
"CW",
"CY",
"CZ",
"DE",
"DJ",
"DK",
"DM",
"DO",
"DZ",
"EC",
"EE",
"EG",
"EH",
"ER",
"ES",
"ET",
"FI",
"FJ",
"FK",
"FO",
"FR",
"GA",
"GB",
"GD",
"GE",
"GF",
"GG",
"GH",
"GI",
"GL",
"GM",
"GN",
"GP",
"GQ",
"GR",
"GS",
"GT",
"GU",
"GW",
"GY",
"HK",
"HN",
"HR",
"HT",
"HU",
"ID",
"IE",
"IL",
"IM",
"IN",
"IO",
"IQ",
"IS",
"IT",
"JE",
"JM",
"JO",
"JP",
"KE",
"KG",
"KH",
"KI",
"KM",
"KN",
"KR",
"KW",
"KY",
"KZ",
"LA",
"LB",
"LC",
"LI",
"LK",
"LR",
"LS",
"LT",
"LU",
"LV",
"LY",
"MA",
"MC",
"MD",
"ME",
"MF",
"MG",
"MK",
"ML",
"MM",
"MN",
"MO",
"MQ",
"MR",
"MS",
"MT",
"MU",
"MV",
"MW",
"MX",
"MY",
"MZ",
"NA",
"NC",
"NE",
"NG",
"NI",
"NL",
"NO",
"NP",
"NR",
"NU",
"NZ",
"OM",
"PA",
"PE",
"PF",
"PG",
"PH",
"PK",
"PL",
"PM",
"PN",
"PR",
"PS",
"PT",
"PY",
"QA",
"RE",
"RO",
"RS",
"RU",
"RW",
"SA",
"SB",
"SC",
"SD",
"SE",
"SG",
"SH",
"SI",
"SJ",
"SK",
"SL",
"SM",
"SN",
"SO",
"SR",
"SS",
"ST",
"SV",
"SX",
"SZ",
"TA",
"TC",
"TD",
"TF",
"TG",
"TH",
"TJ",
"TK",
"TL",
"TM",
"TN",
"TO",
"TR",
"TT",
"TV",
"TW",
"TZ",
"UA",
"UG",
"US",
"UY",
"UZ",
"VA",
"VC",
"VE",
"VG",
"VN",
"VU",
"WF",
"WS",
"XK",
"YE",
"YT",
"ZA",
"ZM",
"ZW",
"ZZ"
],
"type": "string"
},
"description": "An array of two-letter ISO country codes representing which countries Checkout should provide as options for\nshipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SY, UM, VI`."
}
},
"description": "",
"x-expandableFields": []
}
payment_pages_checkout_session_shipping_cost
{
"type": "object",
"title": "PaymentPagesCheckoutSessionShippingCost",
"required": [
"amount_subtotal",
"amount_tax",
"amount_total"
],
"properties": {
"taxes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/line_items_tax_amount"
},
"description": "The taxes applied to the shipping rate."
},
"amount_tax": {
"type": "integer",
"description": "Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0."
},
"amount_total": {
"type": "integer",
"description": "Total shipping cost after discounts and taxes are applied."
},
"shipping_rate": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/shipping_rate"
}
],
"nullable": true,
"description": "The ID of the ShippingRate for this order.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/shipping_rate"
}
]
}
},
"amount_subtotal": {
"type": "integer",
"description": "Total shipping cost before any discounts or taxes are applied."
}
},
"description": "",
"x-expandableFields": [
"shipping_rate",
"taxes"
]
}
payment_pages_checkout_session_shipping_option
{
"type": "object",
"title": "PaymentPagesCheckoutSessionShippingOption",
"required": [
"shipping_amount",
"shipping_rate"
],
"properties": {
"shipping_rate": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/shipping_rate"
}
],
"description": "The shipping rate.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/shipping_rate"
}
]
}
},
"shipping_amount": {
"type": "integer",
"description": "A non-negative integer in cents representing how much to charge."
}
},
"description": "",
"x-expandableFields": [
"shipping_rate"
]
}
payment_pages_checkout_session_tax_id
{
"type": "object",
"title": "PaymentPagesCheckoutSessionTaxID",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"ad_nrt",
"ae_trn",
"al_tin",
"am_tin",
"ao_tin",
"ar_cuit",
"au_abn",
"au_arn",
"aw_tin",
"az_tin",
"ba_tin",
"bb_tin",
"bd_bin",
"bf_ifu",
"bg_uic",
"bh_vat",
"bj_ifu",
"bo_tin",
"br_cnpj",
"br_cpf",
"bs_tin",
"by_tin",
"ca_bn",
"ca_gst_hst",
"ca_pst_bc",
"ca_pst_mb",
"ca_pst_sk",
"ca_qst",
"cd_nif",
"ch_uid",
"ch_vat",
"cl_tin",
"cm_niu",
"cn_tin",
"co_nit",
"cr_tin",
"cv_nif",
"de_stn",
"do_rcn",
"ec_ruc",
"eg_tin",
"es_cif",
"et_tin",
"eu_oss_vat",
"eu_vat",
"fo_vat",
"gb_vat",
"ge_vat",
"gi_tin",
"gn_nif",
"hk_br",
"hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
"in_gst",
"is_vat",
"it_cf",
"jp_cn",
"jp_rn",
"jp_trn",
"ke_pin",
"kg_tin",
"kh_tin",
"kr_brn",
"kz_bin",
"la_tin",
"li_uid",
"li_vat",
"lk_vat",
"ma_vat",
"md_vat",
"me_pib",
"mk_vat",
"mr_nif",
"mx_rfc",
"my_frp",
"my_itn",
"my_sst",
"ng_tin",
"no_vat",
"no_voec",
"np_pan",
"nz_gst",
"om_vat",
"pe_ruc",
"ph_tin",
"pl_nip",
"py_ruc",
"ro_tin",
"rs_pib",
"ru_inn",
"ru_kpp",
"sa_vat",
"sg_gst",
"sg_uen",
"si_tin",
"sn_ninea",
"sr_fin",
"sv_nit",
"th_vat",
"tj_tin",
"tr_tin",
"tw_vat",
"tz_vat",
"ua_vat",
"ug_tin",
"unknown",
"us_ein",
"uy_ruc",
"uz_tin",
"uz_vat",
"ve_rif",
"vn_tin",
"za_vat",
"zm_tin",
"zw_tin"
],
"type": "string",
"description": "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `it_cf`, `fo_vat`, `gi_tin`, `py_ruc`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`"
},
"value": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The value of the tax ID."
}
},
"description": "",
"x-expandableFields": []
}
payment_pages_checkout_session_tax_id_collection
{
"type": "object",
"title": "PaymentPagesCheckoutSessionTaxIDCollection",
"required": [
"enabled",
"required"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates whether tax ID collection is enabled for the session"
},
"required": {
"enum": [
"if_supported",
"never"
],
"type": "string",
"description": "Indicates whether a tax ID is required on the payment page"
}
},
"description": "",
"x-expandableFields": []
}
payment_pages_checkout_session_total_details
{
"type": "object",
"title": "PaymentPagesCheckoutSessionTotalDetails",
"required": [
"amount_discount",
"amount_tax"
],
"properties": {
"breakdown": {
"$ref": "#/components/schemas/payment_pages_checkout_session_total_details_resource_breakdown"
},
"amount_tax": {
"type": "integer",
"description": "This is the sum of all the tax amounts."
},
"amount_discount": {
"type": "integer",
"description": "This is the sum of all the discounts."
},
"amount_shipping": {
"type": "integer",
"nullable": true,
"description": "This is the sum of all the shipping amounts."
}
},
"description": "",
"x-expandableFields": [
"breakdown"
]
}
payment_pages_checkout_session_total_details_resource_breakdown
{
"type": "object",
"title": "PaymentPagesCheckoutSessionTotalDetailsResourceBreakdown",
"required": [
"discounts",
"taxes"
],
"properties": {
"taxes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/line_items_tax_amount"
},
"description": "The aggregated tax amounts by rate."
},
"discounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/line_items_discount_amount"
},
"description": "The aggregated discounts."
}
},
"description": "",
"x-expandableFields": [
"discounts",
"taxes"
]
}
payment_pages_private_card_payment_method_options_resource_restrictions
{
"type": "object",
"title": "PaymentPagesPrivateCardPaymentMethodOptionsResourceRestrictions",
"properties": {
"brands_blocked": {
"type": "array",
"items": {
"enum": [
"american_express",
"discover_global_network",
"mastercard",
"visa"
],
"type": "string"
},
"description": "The card brands to block. If a customer enters or selects a card belonging to a blocked brand, they can't complete the payment."
}
},
"description": "",
"x-expandableFields": []
}
payment_record
{
"type": "object",
"title": "PaymentRecord",
"required": [
"amount",
"amount_authorized",
"amount_canceled",
"amount_failed",
"amount_guaranteed",
"amount_refunded",
"amount_requested",
"created",
"id",
"livemode",
"metadata",
"object",
"processor_details",
"reported_by"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"amount": {
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
},
"object": {
"enum": [
"payment_record"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"metadata": {
"type": "object",
"description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"application": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the Connect application that created the PaymentRecord."
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An arbitrary string attached to the object. Often useful for displaying to users."
},
"reported_by": {
"enum": [
"self",
"stripe"
],
"type": "string",
"description": "Indicates who reported the payment."
},
"amount_failed": {
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
},
"amount_canceled": {
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
},
"amount_refunded": {
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
},
"amount_requested": {
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
},
"customer_details": {
"anyOf": [
{
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_customer_details"
}
],
"nullable": true,
"description": "Customer information for this payment."
},
"shipping_details": {
"anyOf": [
{
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_shipping_details"
}
],
"nullable": true,
"description": "Shipping information for this payment."
},
"amount_authorized": {
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
},
"amount_guaranteed": {
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_amount"
},
"customer_presence": {
"enum": [
"off_session",
"on_session"
],
"type": "string",
"nullable": true,
"description": "Indicates whether the customer was present in your checkout flow during this payment."
},
"processor_details": {
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_processor_details"
},
"payment_method_details": {
"anyOf": [
{
"$ref": "#/components/schemas/payments_primitives_payment_records_resource_payment_method_details"
}
],
"nullable": true,
"description": "Information about the Payment Method debited for this payment."
},
"latest_payment_attempt_record": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the latest Payment Attempt Record attached to this Payment Record."
}
},
"description": "A Payment Record is a resource that allows you to represent payments that occur on- or off-Stripe.\nFor example, you can create a Payment Record to model a payment made on a different payment processor,\nin order to mark an Invoice as paid and a Subscription as active. Payment Records consist of one or\nmore Payment Attempt Records, which represent individual attempts made on a payment network.",
"x-resourceId": "payment_record",
"x-expandableFields": [
"amount",
"amount_authorized",
"amount_canceled",
"amount_failed",
"amount_guaranteed",
"amount_refunded",
"amount_requested",
"customer_details",
"payment_method_details",
"processor_details",
"shipping_details"
]
}
payment_source
{
"anyOf": [
{
"$ref": "#/components/schemas/account"
},
{
"$ref": "#/components/schemas/bank_account"
},
{
"$ref": "#/components/schemas/card"
},
{
"$ref": "#/components/schemas/source"
}
],
"title": "Polymorphic",
"x-resourceId": "payment_source",
"x-stripeBypassValidation": true
}
payments_primitives_payment_records_resource_address
{
"type": "object",
"title": "PaymentsPrimitivesPaymentRecordsResourceAddress",
"properties": {
"city": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "City, district, suburb, town, or village."
},
"line1": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Address line 1, such as the street, PO Box, or company name."
},
"line2": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Address line 2, such as the apartment, suite, unit, or building."
},
"state": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."
},
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
},
"postal_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ZIP or postal code."
}
},
"description": "A representation of a physical address.",
"x-expandableFields": []
}