setup_attempt_payment_method_details_ideal
{
"type": "object",
"title": "setup_attempt_payment_method_details_ideal",
"properties": {
"bic": {
"enum": [
"ABNANL2A",
"ADYBNL2A",
"ASNBNL21",
"BITSNL2A",
"BUNQNL2A",
"BUUTNL2A",
"FNOMNL22",
"FVLBNL22",
"HANDNL2A",
"INGBNL2A",
"KNABNL2H",
"MLLENL2A",
"MOYONL21",
"NNBANL2G",
"NTSBDEB1",
"RABONL2U",
"RBRBNL21",
"REVOIE23",
"REVOLT21",
"SNSBNL2A",
"TRIONL2U"
],
"type": "string",
"nullable": true,
"description": "The Bank Identifier Code of the customer's bank."
},
"bank": {
"enum": [
"abn_amro",
"adyen",
"asn_bank",
"bunq",
"buut",
"finom",
"handelsbanken",
"ing",
"knab",
"mollie",
"moneyou",
"n26",
"nn",
"rabobank",
"regiobank",
"revolut",
"sns_bank",
"triodos_bank",
"van_lanschot",
"yoursafe"
],
"type": "string",
"nullable": true,
"description": "The customer's bank. Can be one of `abn_amro`, `adyen`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`."
},
"iban_last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last four characters of the IBAN."
},
"verified_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Owner's verified full name. Values are verified or provided by iDEAL directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."
},
"generated_sepa_debit": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_method"
}
],
"nullable": true,
"description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_method"
}
]
}
},
"generated_sepa_debit_mandate": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/mandate"
}
],
"nullable": true,
"description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/mandate"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"generated_sepa_debit",
"generated_sepa_debit_mandate"
]
}
setup_attempt_payment_method_details_kakao_pay
{
"type": "object",
"title": "setup_attempt_payment_method_details_kakao_pay",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_klarna
{
"type": "object",
"title": "setup_attempt_payment_method_details_klarna",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_kr_card
{
"type": "object",
"title": "setup_attempt_payment_method_details_kr_card",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_link
{
"type": "object",
"title": "setup_attempt_payment_method_details_link",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_naver_pay
{
"type": "object",
"title": "setup_attempt_payment_method_details_naver_pay",
"properties": {
"buyer_id": {
"type": "string",
"maxLength": 5000,
"description": "Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same."
}
},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_nz_bank_account
{
"type": "object",
"title": "setup_attempt_payment_method_details_nz_bank_account",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_paypal
{
"type": "object",
"title": "setup_attempt_payment_method_details_paypal",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_payto
{
"type": "object",
"title": "setup_attempt_payment_method_details_payto",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_pix
{
"type": "object",
"title": "setup_attempt_payment_method_details_pix",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_revolut_pay
{
"type": "object",
"title": "setup_attempt_payment_method_details_revolut_pay",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_sepa_debit
{
"type": "object",
"title": "setup_attempt_payment_method_details_sepa_debit",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_sofort
{
"type": "object",
"title": "setup_attempt_payment_method_details_sofort",
"properties": {
"bic": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Bank Identifier Code of the bank associated with the bank account."
},
"bank_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Bank code of bank associated with the bank account."
},
"bank_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Name of the bank associated with the bank account."
},
"iban_last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last four characters of the IBAN."
},
"verified_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Owner's verified full name. Values are verified or provided by Sofort directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."
},
"preferred_language": {
"enum": [
"de",
"en",
"fr",
"nl"
],
"type": "string",
"nullable": true,
"description": "Preferred language of the Sofort authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`"
},
"generated_sepa_debit": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_method"
}
],
"nullable": true,
"description": "The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_method"
}
]
}
},
"generated_sepa_debit_mandate": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/mandate"
}
],
"nullable": true,
"description": "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/mandate"
}
]
}
}
},
"description": "",
"x-expandableFields": [
"generated_sepa_debit",
"generated_sepa_debit_mandate"
]
}
setup_attempt_payment_method_details_upi
{
"type": "object",
"title": "setup_attempt_payment_method_details_upi",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_attempt_payment_method_details_us_bank_account
{
"type": "object",
"title": "setup_attempt_payment_method_details_us_bank_account",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_intent
{
"type": "object",
"title": "SetupIntent",
"required": [
"created",
"id",
"livemode",
"object",
"payment_method_types",
"status",
"usage"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"usage": {
"type": "string",
"maxLength": 5000,
"description": "Indicates how the payment method is intended to be used in the future.\n\nUse `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`."
},
"object": {
"enum": [
"setup_intent"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"status": {
"enum": [
"canceled",
"processing",
"requires_action",
"requires_confirmation",
"requires_payment_method",
"succeeded"
],
"type": "string",
"description": "[Status](https://docs.stripe.com/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`."
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"mandate": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/mandate"
}
],
"nullable": true,
"description": "ID of the multi use Mandate generated by the SetupIntent.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/mandate"
}
]
}
},
"customer": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/customer"
},
{
"$ref": "#/components/schemas/deleted_customer"
}
],
"nullable": true,
"description": "ID of the Customer this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/customer"
},
{
"$ref": "#/components/schemas/deleted_customer"
}
]
}
},
"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",
"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
}
},
"application": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/application"
}
],
"nullable": true,
"description": "ID of the Connect application that created the SetupIntent.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/application"
}
]
}
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An arbitrary string attached to the object. Often useful for displaying to users."
},
"next_action": {
"anyOf": [
{
"$ref": "#/components/schemas/setup_intent_next_action"
}
],
"nullable": true,
"description": "If present, this property tells you what actions you need to take in order for your customer to continue payment setup."
},
"on_behalf_of": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/account"
}
],
"nullable": true,
"description": "The account (if any) for which the setup is intended.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/account"
}
]
}
},
"client_secret": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.\n\nThe client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret."
},
"attach_to_self": {
"type": "boolean",
"description": "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer."
},
"latest_attempt": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/setup_attempt"
}
],
"nullable": true,
"description": "The most recent SetupAttempt for this SetupIntent.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/setup_attempt"
}
]
}
},
"payment_method": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_method"
}
],
"nullable": true,
"description": "ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_method"
}
]
}
},
"flow_directions": {
"type": "array",
"items": {
"enum": [
"inbound",
"outbound"
],
"type": "string"
},
"nullable": true,
"description": "Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes."
},
"customer_account": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the Account this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent."
},
"last_setup_error": {
"anyOf": [
{
"$ref": "#/components/schemas/api_errors"
}
],
"nullable": true,
"description": "The error encountered in the previous SetupIntent confirmation."
},
"managed_payments": {
"anyOf": [
{
"$ref": "#/components/schemas/smor_resource_managed_payments"
}
],
"nullable": true
},
"single_use_mandate": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/mandate"
}
],
"nullable": true,
"description": "ID of the single_use Mandate generated by the SetupIntent.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/mandate"
}
]
}
},
"cancellation_reason": {
"enum": [
"abandoned",
"duplicate",
"requested_by_customer"
],
"type": "string",
"nullable": true,
"description": "Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`."
},
"payment_method_types": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"description": "The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type)."
},
"payment_method_options": {
"anyOf": [
{
"$ref": "#/components/schemas/setup_intent_payment_method_options"
}
],
"nullable": true,
"description": "Payment method-specific configuration for this SetupIntent."
},
"automatic_payment_methods": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_flows_automatic_payment_methods_setup_intent"
}
],
"nullable": true,
"description": "Settings for dynamic payment methods compatible with this Setup Intent"
},
"excluded_payment_method_types": {
"type": "array",
"items": {
"enum": [
"acss_debit",
"affirm",
"afterpay_clearpay",
"alipay",
"alma",
"amazon_pay",
"au_becs_debit",
"bacs_debit",
"bancontact",
"billie",
"blik",
"boleto",
"card",
"cashapp",
"crypto",
"customer_balance",
"eps",
"fpx",
"giropay",
"grabpay",
"ideal",
"kakao_pay",
"klarna",
"konbini",
"kr_card",
"mb_way",
"mobilepay",
"multibanco",
"naver_pay",
"nz_bank_account",
"oxxo",
"p24",
"pay_by_bank",
"payco",
"paynow",
"paypal",
"payto",
"pix",
"promptpay",
"revolut_pay",
"samsung_pay",
"satispay",
"sepa_debit",
"sofort",
"sunbit",
"swish",
"twint",
"upi",
"us_bank_account",
"wechat_pay",
"zip"
],
"type": "string",
"x-stripeBypassValidation": true
},
"nullable": true,
"description": "Payment method types that are excluded from this SetupIntent."
},
"payment_method_configuration_details": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_config_biz_payment_method_configuration_details"
}
],
"nullable": true,
"description": "Information about the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) used for this Setup Intent."
}
},
"description": "A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.\nFor example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.\nLater, you can use [PaymentIntents](https://api.stripe.com#payment_intents) to drive the payment flow.\n\nCreate a SetupIntent when you're ready to collect your customer's payment credentials.\nDon't maintain long-lived, unconfirmed SetupIntents because they might not be valid.\nThe SetupIntent transitions through multiple [statuses](https://docs.stripe.com/payments/intents#intent-statuses) as it guides\nyou through the setup process.\n\nSuccessful SetupIntents result in payment credentials that are optimized for future payments.\nFor example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through\n[Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection\nto streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents).\nIf you use the SetupIntent with a [Customer](https://api.stripe.com#setup_intent_object-customer),\nit automatically attaches the resulting payment method to that Customer after successful setup.\nWe recommend using SetupIntents or [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) on\nPaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.\n\nBy using SetupIntents, you can reduce friction for your customers, even as regulations change over time.\n\nRelated guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents)",
"x-resourceId": "setup_intent",
"x-expandableFields": [
"application",
"automatic_payment_methods",
"customer",
"last_setup_error",
"latest_attempt",
"managed_payments",
"mandate",
"next_action",
"on_behalf_of",
"payment_method",
"payment_method_configuration_details",
"payment_method_options",
"single_use_mandate"
]
}
setup_intent_next_action
{
"type": "object",
"title": "SetupIntentNextAction",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"maxLength": 5000,
"description": "Type of the next action to perform. Refer to the other child attributes under `next_action` for available values. Examples include: `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`."
},
"use_stripe_sdk": {
"type": "object",
"description": "When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js."
},
"redirect_to_url": {
"$ref": "#/components/schemas/setup_intent_next_action_redirect_to_url"
},
"pix_display_qr_code": {
"$ref": "#/components/schemas/setup_intent_next_action_pix_display_qr_code"
},
"verify_with_microdeposits": {
"$ref": "#/components/schemas/setup_intent_next_action_verify_with_microdeposits"
},
"upi_handle_redirect_or_display_qr_code": {
"$ref": "#/components/schemas/payment_intent_next_action_upi_handle_redirect_or_display_qr_code"
},
"cashapp_handle_redirect_or_display_qr_code": {
"$ref": "#/components/schemas/payment_intent_next_action_cashapp_handle_redirect_or_display_qr_code"
}
},
"description": "",
"x-expandableFields": [
"cashapp_handle_redirect_or_display_qr_code",
"pix_display_qr_code",
"redirect_to_url",
"upi_handle_redirect_or_display_qr_code",
"verify_with_microdeposits"
]
}
setup_intent_next_action_pix_display_qr_code
{
"type": "object",
"title": "SetupIntentNextActionPixDisplayQrCode",
"required": [
"data",
"expires_at",
"hosted_instructions_url",
"image_url_png",
"image_url_svg"
],
"properties": {
"data": {
"type": "string",
"maxLength": 5000,
"description": "The raw data string used to generate QR code, it should be used together with QR code library."
},
"expires_at": {
"type": "integer",
"format": "unix-time",
"description": "The date (unix timestamp) when the PIX expires."
},
"image_url_png": {
"type": "string",
"maxLength": 5000,
"description": "The image_url_png string used to render png QR code"
},
"image_url_svg": {
"type": "string",
"maxLength": 5000,
"description": "The image_url_svg string used to render svg QR code"
},
"hosted_instructions_url": {
"type": "string",
"maxLength": 5000,
"description": "The URL to the hosted pix instructions page, which allows customers to view the pix QR code."
}
},
"description": "",
"x-expandableFields": []
}
setup_intent_next_action_redirect_to_url
{
"type": "object",
"title": "SetupIntentNextActionRedirectToUrl",
"properties": {
"url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The URL you must redirect your customer to in order to authenticate."
},
"return_url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion."
}
},
"description": "",
"x-expandableFields": []
}
setup_intent_next_action_verify_with_microdeposits
{
"type": "object",
"title": "SetupIntentNextActionVerifyWithMicrodeposits",
"required": [
"arrival_date",
"hosted_verification_url"
],
"properties": {
"arrival_date": {
"type": "integer",
"format": "unix-time",
"description": "The timestamp when the microdeposits are expected to land."
},
"microdeposit_type": {
"enum": [
"amounts",
"descriptor_code"
],
"type": "string",
"nullable": true,
"description": "The type of the microdeposit sent to the customer. Used to distinguish between different verification methods."
},
"hosted_verification_url": {
"type": "string",
"maxLength": 5000,
"description": "The URL for the hosted verification page, which allows customers to verify their bank account."
}
},
"description": "",
"x-expandableFields": []
}
setup_intent_payment_method_options
{
"type": "object",
"title": "SetupIntentPaymentMethodOptions",
"properties": {
"pix": {
"anyOf": [
{
"$ref": "#/components/schemas/setup_intent_payment_method_options_pix"
},
{
"$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
}
]
},
"upi": {
"anyOf": [
{
"$ref": "#/components/schemas/setup_intent_payment_method_options_upi"
},
{
"$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
}
]
},
"card": {
"anyOf": [
{
"$ref": "#/components/schemas/setup_intent_payment_method_options_card"
},
{
"$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
}
]
},
"link": {
"anyOf": [
{
"$ref": "#/components/schemas/setup_intent_payment_method_options_link"
},
{
"$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
}
]
},
"payto": {
"anyOf": [
{
"$ref": "#/components/schemas/setup_intent_payment_method_options_payto"
},
{
"$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
}
]
},
"klarna": {
"anyOf": [
{
"$ref": "#/components/schemas/setup_intent_payment_method_options_klarna"
},
{
"$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
}
]
},
"paypal": {
"anyOf": [
{
"$ref": "#/components/schemas/setup_intent_payment_method_options_paypal"
},
{
"$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
}
]
},
"acss_debit": {
"anyOf": [
{
"$ref": "#/components/schemas/setup_intent_payment_method_options_acss_debit"
},
{
"$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
}
]
},
"amazon_pay": {
"anyOf": [
{
"$ref": "#/components/schemas/setup_intent_payment_method_options_amazon_pay"
},
{
"$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
}
]
},
"bacs_debit": {
"anyOf": [
{
"$ref": "#/components/schemas/setup_intent_payment_method_options_bacs_debit"
},
{
"$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
}
]
},
"sepa_debit": {
"anyOf": [
{
"$ref": "#/components/schemas/setup_intent_payment_method_options_sepa_debit"
},
{
"$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
}
]
},
"card_present": {
"anyOf": [
{
"$ref": "#/components/schemas/setup_intent_payment_method_options_card_present"
},
{
"$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
}
]
},
"us_bank_account": {
"anyOf": [
{
"$ref": "#/components/schemas/setup_intent_payment_method_options_us_bank_account"
},
{
"$ref": "#/components/schemas/setup_intent_type_specific_payment_method_options_client"
}
]
}
},
"description": "",
"x-expandableFields": [
"acss_debit",
"amazon_pay",
"bacs_debit",
"card",
"card_present",
"klarna",
"link",
"paypal",
"payto",
"pix",
"sepa_debit",
"upi",
"us_bank_account"
]
}
setup_intent_payment_method_options_acss_debit
{
"type": "object",
"title": "setup_intent_payment_method_options_acss_debit",
"properties": {
"currency": {
"enum": [
"cad",
"usd"
],
"type": "string",
"nullable": true,
"description": "Currency supported by the bank account"
},
"mandate_options": {
"$ref": "#/components/schemas/setup_intent_payment_method_options_mandate_options_acss_debit"
},
"verification_method": {
"enum": [
"automatic",
"instant",
"microdeposits"
],
"type": "string",
"description": "Bank account verification method. The default value is `automatic`.",
"x-stripeBypassValidation": true
}
},
"description": "",
"x-expandableFields": [
"mandate_options"
]
}
setup_intent_payment_method_options_amazon_pay
{
"type": "object",
"title": "setup_intent_payment_method_options_amazon_pay",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_intent_payment_method_options_bacs_debit
{
"type": "object",
"title": "setup_intent_payment_method_options_bacs_debit",
"properties": {
"mandate_options": {
"$ref": "#/components/schemas/setup_intent_payment_method_options_mandate_options_bacs_debit"
}
},
"description": "",
"x-expandableFields": [
"mandate_options"
]
}
setup_intent_payment_method_options_card
{
"type": "object",
"title": "setup_intent_payment_method_options_card",
"properties": {
"network": {
"enum": [
"amex",
"cartes_bancaires",
"diners",
"discover",
"eftpos_au",
"girocard",
"interac",
"jcb",
"link",
"mastercard",
"unionpay",
"unknown",
"visa"
],
"type": "string",
"nullable": true,
"description": "Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time."
},
"mandate_options": {
"anyOf": [
{
"$ref": "#/components/schemas/setup_intent_payment_method_options_card_mandate_options"
}
],
"nullable": true,
"description": "Configuration options for setting up an eMandate for cards issued in India."
},
"request_three_d_secure": {
"enum": [
"any",
"automatic",
"challenge"
],
"type": "string",
"nullable": true,
"description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication). 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](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
"x-stripeBypassValidation": true
}
},
"description": "",
"x-expandableFields": [
"mandate_options"
]
}
setup_intent_payment_method_options_card_mandate_options
{
"type": "object",
"title": "setup_intent_payment_method_options_card_mandate_options",
"required": [
"amount",
"amount_type",
"currency",
"interval",
"reference",
"start_date"
],
"properties": {
"amount": {
"type": "integer",
"description": "Amount to be charged for future payments, specified in the presentment currency."
},
"currency": {
"type": "string",
"format": "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)."
},
"end_date": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date."
},
"interval": {
"enum": [
"day",
"month",
"sporadic",
"week",
"year"
],
"type": "string",
"description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`."
},
"reference": {
"type": "string",
"maxLength": 80,
"description": "Unique identifier for the mandate or subscription."
},
"start_date": {
"type": "integer",
"format": "unix-time",
"description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday."
},
"amount_type": {
"enum": [
"fixed",
"maximum"
],
"type": "string",
"description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param."
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 200,
"description": "A description of the mandate or subscription that is meant to be displayed to the customer."
},
"interval_count": {
"type": "integer",
"nullable": true,
"description": "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`."
},
"supported_types": {
"type": "array",
"items": {
"enum": [
"india"
],
"type": "string"
},
"nullable": true,
"description": "Specifies the type of mandates supported. Possible values are `india`."
}
},
"description": "",
"x-expandableFields": []
}
setup_intent_payment_method_options_card_present
{
"type": "object",
"title": "setup_intent_payment_method_options_card_present",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_intent_payment_method_options_klarna
{
"type": "object",
"title": "setup_intent_payment_method_options_klarna",
"properties": {
"currency": {
"type": "string",
"format": "currency",
"nullable": true,
"description": "The currency of the setup intent. Three letter ISO currency code."
},
"preferred_locale": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Preferred locale of the Klarna checkout page that the customer is redirected to."
}
},
"description": "",
"x-expandableFields": []
}
setup_intent_payment_method_options_link
{
"type": "object",
"title": "setup_intent_payment_method_options_link",
"properties": {},
"description": "",
"x-expandableFields": []
}
setup_intent_payment_method_options_mandate_options_acss_debit
{
"type": "object",
"title": "setup_intent_payment_method_options_mandate_options_acss_debit",
"properties": {
"default_for": {
"type": "array",
"items": {
"enum": [
"invoice",
"subscription"
],
"type": "string"
},
"description": "List of Stripe products where this mandate can be selected automatically."
},
"payment_schedule": {
"enum": [
"combined",
"interval",
"sporadic"
],
"type": "string",
"nullable": true,
"description": "Payment schedule for the mandate."
},
"transaction_type": {
"enum": [
"business",
"personal"
],
"type": "string",
"nullable": true,
"description": "Transaction type of the mandate."
},
"custom_mandate_url": {
"type": "string",
"maxLength": 5000,
"description": "A URL for custom mandate text"
},
"interval_description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'."
}
},
"description": "",
"x-expandableFields": []
}
setup_intent_payment_method_options_mandate_options_bacs_debit
{
"type": "object",
"title": "setup_intent_payment_method_options_mandate_options_bacs_debit",
"properties": {
"reference_prefix": {
"type": "string",
"maxLength": 5000,
"description": "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'."
}
},
"description": "",
"x-expandableFields": []
}
setup_intent_payment_method_options_mandate_options_payto
{
"type": "object",
"title": "setup_intent_payment_method_options_mandate_options_payto",
"properties": {
"amount": {
"type": "integer",
"nullable": true,
"description": "Amount that will be collected. It is required when `amount_type` is `fixed`."
},
"purpose": {
"enum": [
"dependant_support",
"government",
"loan",
"mortgage",
"other",
"pension",
"personal",
"retail",
"salary",
"tax",
"utility"
],
"type": "string",
"nullable": true,
"description": "The purpose for which payments are made. Has a default value based on your merchant category code."
},
"end_date": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date."
},
"start_date": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time."
},
"amount_type": {
"enum": [
"fixed",
"maximum"
],
"type": "string",
"nullable": true,
"description": "The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`."
},
"payment_schedule": {
"enum": [
"adhoc",
"annual",
"daily",
"fortnightly",
"monthly",
"quarterly",
"semi_annual",
"weekly"
],
"type": "string",
"nullable": true,
"description": "The periodicity at which payments will be collected. Defaults to `adhoc`."
},
"payments_per_period": {
"type": "integer",
"nullable": true,
"description": "The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit."
}
},
"description": "",
"x-expandableFields": []
}
setup_intent_payment_method_options_mandate_options_sepa_debit
{
"type": "object",
"title": "setup_intent_payment_method_options_mandate_options_sepa_debit",
"properties": {
"reference_prefix": {
"type": "string",
"maxLength": 5000,
"description": "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'."
}
},
"description": "",
"x-expandableFields": []
}
setup_intent_payment_method_options_paypal
{
"type": "object",
"title": "setup_intent_payment_method_options_paypal",
"properties": {
"billing_agreement_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer."
}
},
"description": "",
"x-expandableFields": []
}
setup_intent_payment_method_options_payto
{
"type": "object",
"title": "setup_intent_payment_method_options_payto",
"properties": {
"mandate_options": {
"$ref": "#/components/schemas/setup_intent_payment_method_options_mandate_options_payto"
}
},
"description": "",
"x-expandableFields": [
"mandate_options"
]
}
setup_intent_payment_method_options_pix
{
"type": "object",
"title": "setup_intent_payment_method_options_pix",
"properties": {
"mandate_options": {
"$ref": "#/components/schemas/payment_method_options_mandate_options_pix"
}
},
"description": "",
"x-expandableFields": [
"mandate_options"
]
}
setup_intent_payment_method_options_sepa_debit
{
"type": "object",
"title": "setup_intent_payment_method_options_sepa_debit",
"properties": {
"mandate_options": {
"$ref": "#/components/schemas/setup_intent_payment_method_options_mandate_options_sepa_debit"
}
},
"description": "",
"x-expandableFields": [
"mandate_options"
]
}
setup_intent_payment_method_options_upi
{
"type": "object",
"title": "setup_intent_payment_method_options_upi",
"properties": {
"mandate_options": {
"$ref": "#/components/schemas/payment_method_options_mandate_options_upi"
}
},
"description": "",
"x-expandableFields": [
"mandate_options"
]
}
setup_intent_payment_method_options_us_bank_account
{
"type": "object",
"title": "setup_intent_payment_method_options_us_bank_account",
"properties": {
"mandate_options": {
"$ref": "#/components/schemas/payment_method_options_us_bank_account_mandate_options"
},
"verification_method": {
"enum": [
"automatic",
"instant",
"microdeposits"
],
"type": "string",
"description": "Bank account verification method. The default value is `automatic`.",
"x-stripeBypassValidation": true
},
"financial_connections": {
"$ref": "#/components/schemas/linked_account_options_common"
}
},
"description": "",
"x-expandableFields": [
"financial_connections",
"mandate_options"
]
}
setup_intent_type_specific_payment_method_options_client
{
"type": "object",
"title": "SetupIntentTypeSpecificPaymentMethodOptionsClient",
"properties": {
"mandate_options": {
"$ref": "#/components/schemas/setup_intent_payment_method_options_mandate_options_payto"
},
"verification_method": {
"enum": [
"automatic",
"instant",
"microdeposits"
],
"type": "string",
"description": "Bank account verification method. The default value is `automatic`.",
"x-stripeBypassValidation": true
}
},
"description": "",
"x-expandableFields": [
"mandate_options"
]
}
shipping
{
"type": "object",
"title": "Shipping",
"properties": {
"name": {
"type": "string",
"maxLength": 5000,
"description": "Recipient name."
},
"phone": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Recipient phone (including extension)."
},
"address": {
"$ref": "#/components/schemas/address"
},
"carrier": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc."
},
"tracking_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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."
}
},
"description": "",
"x-expandableFields": [
"address"
]
}
shipping_rate
{
"type": "object",
"title": "ShippingRate",
"required": [
"active",
"created",
"id",
"livemode",
"metadata",
"object",
"type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"type": {
"enum": [
"fixed_amount"
],
"type": "string",
"description": "The type of calculation to use on the shipping rate."
},
"active": {
"type": "boolean",
"description": "Whether the shipping rate can be used for new purchases. Defaults to `true`."
},
"object": {
"enum": [
"shipping_rate"
],
"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
}
},
"tax_code": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/tax_code"
}
],
"nullable": true,
"description": "A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/tax_code"
}
]
}
},
"display_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions."
},
"fixed_amount": {
"$ref": "#/components/schemas/shipping_rate_fixed_amount"
},
"tax_behavior": {
"enum": [
"exclusive",
"inclusive",
"unspecified"
],
"type": "string",
"nullable": true,
"description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`."
},
"delivery_estimate": {
"anyOf": [
{
"$ref": "#/components/schemas/shipping_rate_delivery_estimate"
}
],
"nullable": true,
"description": "The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions."
}
},
"description": "Shipping rates describe the price of shipping presented to your customers and\napplied to a purchase. For more information, see [Charge for shipping](https://docs.stripe.com/payments/during-payment/charge-shipping).",
"x-resourceId": "shipping_rate",
"x-expandableFields": [
"delivery_estimate",
"fixed_amount",
"tax_code"
]
}
shipping_rate_currency_option
{
"type": "object",
"title": "ShippingRateCurrencyOption",
"required": [
"amount",
"tax_behavior"
],
"properties": {
"amount": {
"type": "integer",
"description": "A non-negative integer in cents representing how much to charge."
},
"tax_behavior": {
"enum": [
"exclusive",
"inclusive",
"unspecified"
],
"type": "string",
"description": "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`."
}
},
"description": "",
"x-expandableFields": []
}
shipping_rate_delivery_estimate
{
"type": "object",
"title": "ShippingRateDeliveryEstimate",
"properties": {
"maximum": {
"anyOf": [
{
"$ref": "#/components/schemas/shipping_rate_delivery_estimate_bound"
}
],
"nullable": true,
"description": "The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite."
},
"minimum": {
"anyOf": [
{
"$ref": "#/components/schemas/shipping_rate_delivery_estimate_bound"
}
],
"nullable": true,
"description": "The lower bound of the estimated range. If empty, represents no lower bound."
}
},
"description": "",
"x-expandableFields": [
"maximum",
"minimum"
]
}
shipping_rate_delivery_estimate_bound
{
"type": "object",
"title": "ShippingRateDeliveryEstimateBound",
"required": [
"unit",
"value"
],
"properties": {
"unit": {
"enum": [
"business_day",
"day",
"hour",
"month",
"week"
],
"type": "string",
"description": "A unit of time."
},
"value": {
"type": "integer",
"description": "Must be greater than 0."
}
},
"description": "",
"x-expandableFields": []
}
shipping_rate_fixed_amount
{
"type": "object",
"title": "ShippingRateFixedAmount",
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "integer",
"description": "A non-negative integer in cents representing how much to charge."
},
"currency": {
"type": "string",
"format": "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)."
},
"currency_options": {
"type": "object",
"description": "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).",
"additionalProperties": {
"$ref": "#/components/schemas/shipping_rate_currency_option"
}
}
},
"description": "",
"x-expandableFields": [
"currency_options"
]
}
sigma.sigma_api_query
{
"type": "object",
"title": "SigmaSigmaResourcesSigmaAPIQuery",
"required": [
"created",
"id",
"livemode",
"name",
"object",
"sql"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"sql": {
"type": "string",
"maxLength": 5000,
"description": "The sql statement for the query."
},
"name": {
"type": "string",
"maxLength": 5000,
"description": "The name of the query."
},
"object": {
"enum": [
"sigma.sigma_api_query"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"created": {
"type": "integer",
"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`."
}
},
"description": "A saved query object represents a query that can be executed for a run.",
"x-resourceId": "sigma.sigma_api_query",
"x-expandableFields": []
}
sigma_scheduled_query_run_error
{
"type": "object",
"title": "SigmaScheduledQueryRunError",
"required": [
"message"
],
"properties": {
"message": {
"type": "string",
"maxLength": 5000,
"description": "Information about the run failure."
}
},
"description": "",
"x-expandableFields": []
}
smor_resource_managed_payments
{
"type": "object",
"title": "SmorResourceManagedPayments",
"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": []
}
source
{
"type": "object",
"title": "Source",
"required": [
"client_secret",
"created",
"flow",
"id",
"livemode",
"object",
"status",
"type"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"eps": {
"$ref": "#/components/schemas/source_type_eps"
},
"p24": {
"$ref": "#/components/schemas/source_type_p24"
},
"card": {
"$ref": "#/components/schemas/source_type_card"
},
"flow": {
"type": "string",
"maxLength": 5000,
"description": "The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`."
},
"type": {
"enum": [
"ach_credit_transfer",
"ach_debit",
"acss_debit",
"alipay",
"au_becs_debit",
"bancontact",
"card",
"card_present",
"eps",
"giropay",
"ideal",
"klarna",
"multibanco",
"p24",
"sepa_debit",
"sofort",
"three_d_secure",
"wechat"
],
"type": "string",
"description": "The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://docs.stripe.com/sources) used.",
"x-stripeBypassValidation": true
},
"ideal": {
"$ref": "#/components/schemas/source_type_ideal"
},
"owner": {
"anyOf": [
{
"$ref": "#/components/schemas/source_owner"
}
],
"nullable": true,
"description": "Information about the owner of the payment instrument that may be used or required by particular source types."
},
"usage": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned."
},
"alipay": {
"$ref": "#/components/schemas/source_type_alipay"
},
"amount": {
"type": "integer",
"nullable": true,
"description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources."
},
"klarna": {
"$ref": "#/components/schemas/source_type_klarna"
},
"object": {
"enum": [
"source"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"sofort": {
"$ref": "#/components/schemas/source_type_sofort"
},
"status": {
"type": "string",
"maxLength": 5000,
"description": "The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge."
},
"wechat": {
"$ref": "#/components/schemas/source_type_wechat"
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"giropay": {
"$ref": "#/components/schemas/source_type_giropay"
},
"currency": {
"type": "string",
"format": "currency",
"nullable": true,
"description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources."
},
"customer": {
"type": "string",
"maxLength": 5000,
"description": "The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer."
},
"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",
"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
}
},
"receiver": {
"$ref": "#/components/schemas/source_receiver_flow"
},
"redirect": {
"$ref": "#/components/schemas/source_redirect_flow"
},
"ach_debit": {
"$ref": "#/components/schemas/source_type_ach_debit"
},
"acss_debit": {
"$ref": "#/components/schemas/source_type_acss_debit"
},
"bancontact": {
"$ref": "#/components/schemas/source_type_bancontact"
},
"multibanco": {
"$ref": "#/components/schemas/source_type_multibanco"
},
"sepa_debit": {
"$ref": "#/components/schemas/source_type_sepa_debit"
},
"card_present": {
"$ref": "#/components/schemas/source_type_card_present"
},
"source_order": {
"$ref": "#/components/schemas/source_order"
},
"au_becs_debit": {
"$ref": "#/components/schemas/source_type_au_becs_debit"
},
"client_secret": {
"type": "string",
"maxLength": 5000,
"description": "The client secret of the source. Used for client-side retrieval using a publishable key."
},
"three_d_secure": {
"$ref": "#/components/schemas/source_type_three_d_secure"
},
"allow_redisplay": {
"enum": [
"always",
"limited",
"unspecified"
],
"type": "string",
"nullable": true,
"description": "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”."
},
"code_verification": {
"$ref": "#/components/schemas/source_code_verification_flow"
},
"ach_credit_transfer": {
"$ref": "#/components/schemas/source_type_ach_credit_transfer"
},
"statement_descriptor": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Extra information about a source. This will appear on your customer's statement every time you charge the source."
}
},
"description": "`Source` objects allow you to accept a variety of payment methods. They\nrepresent a customer's payment instrument, and can be used with the Stripe API\njust like a `Card` object: once chargeable, they can be charged, or can be\nattached to customers.\n\nStripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources).\nWe recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods).\nThis newer API provides access to our latest features and payment method types.\n\nRelated guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers).",
"x-resourceId": "source",
"x-expandableFields": [
"code_verification",
"owner",
"receiver",
"redirect",
"source_order"
]
}