payment_intent_next_action_upiqr_code
{
"type": "object",
"title": "PaymentIntentNextActionUPIQRCode",
"required": [
"expires_at",
"image_url_png",
"image_url_svg"
],
"properties": {
"expires_at": {
"type": "integer",
"format": "unix-time",
"description": "The date (unix timestamp) when the QR code expires."
},
"image_url_png": {
"type": "string",
"maxLength": 5000,
"description": "The image_url_png string used to render QR code"
},
"image_url_svg": {
"type": "string",
"maxLength": 5000,
"description": "The image_url_svg string used to render QR code"
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_next_action_verify_with_microdeposits
{
"type": "object",
"title": "PaymentIntentNextActionVerifyWithMicrodeposits",
"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": []
}
payment_intent_next_action_wechat_pay_display_qr_code
{
"type": "object",
"title": "PaymentIntentNextActionWechatPayDisplayQrCode",
"required": [
"data",
"hosted_instructions_url",
"image_data_url",
"image_url_png",
"image_url_svg"
],
"properties": {
"data": {
"type": "string",
"maxLength": 5000,
"description": "The data being used to generate QR code"
},
"image_url_png": {
"type": "string",
"maxLength": 5000,
"description": "The image_url_png string used to render QR code"
},
"image_url_svg": {
"type": "string",
"maxLength": 5000,
"description": "The image_url_svg string used to render QR code"
},
"image_data_url": {
"type": "string",
"maxLength": 5000,
"description": "The base64 image data for a pre-generated QR code"
},
"hosted_instructions_url": {
"type": "string",
"maxLength": 5000,
"description": "The URL to the hosted WeChat Pay instructions page, which allows customers to view the WeChat Pay QR code."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_next_action_wechat_pay_redirect_to_android_app
{
"type": "object",
"title": "PaymentIntentNextActionWechatPayRedirectToAndroidApp",
"required": [
"app_id",
"nonce_str",
"package",
"partner_id",
"prepay_id",
"sign",
"timestamp"
],
"properties": {
"sign": {
"type": "string",
"maxLength": 5000,
"description": "A signature"
},
"app_id": {
"type": "string",
"maxLength": 5000,
"description": "app_id is the APP ID registered on WeChat open platform"
},
"package": {
"type": "string",
"maxLength": 5000,
"description": "package is static value"
},
"nonce_str": {
"type": "string",
"maxLength": 5000,
"description": "nonce_str is a random string"
},
"prepay_id": {
"type": "string",
"maxLength": 5000,
"description": "an unique trading ID assigned by WeChat Pay"
},
"timestamp": {
"type": "string",
"maxLength": 5000,
"description": "Specifies the current time in epoch format"
},
"partner_id": {
"type": "string",
"maxLength": 5000,
"description": "an unique merchant ID assigned by WeChat Pay"
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_next_action_wechat_pay_redirect_to_ios_app
{
"type": "object",
"title": "PaymentIntentNextActionWechatPayRedirectToIOSApp",
"required": [
"native_url"
],
"properties": {
"native_url": {
"type": "string",
"maxLength": 5000,
"description": "An universal link that redirect to WeChat Pay app"
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_payment_method_options
{
"type": "object",
"title": "PaymentIntentPaymentMethodOptions",
"properties": {
"eps": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_eps"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"fpx": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_fpx"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"p24": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_p24"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"pix": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_pix"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"upi": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_upi"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"zip": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_zip"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"alma": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_alma"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"blik": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_blik"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"card": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_card"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"link": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_link"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"oxxo": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_oxxo"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"bizum": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_bizum"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"ideal": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_ideal"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"payco": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_flows_private_payment_methods_payco_payment_method_options"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"payto": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_payto"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"swish": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_swish"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"twint": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_twint"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"affirm": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_affirm"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"alipay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_alipay"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"billie": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_billie"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"boleto": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_boleto"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"crypto": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_crypto"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"klarna": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_klarna"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"mb_way": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_mb_way"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"paynow": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_paynow"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"paypal": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_paypal"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"sofort": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_sofort"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"sunbit": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_sunbit"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"cashapp": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_cashapp"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"giropay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_giropay"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"grabpay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_grabpay"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"konbini": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_konbini"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"kr_card": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_kr_card"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"satispay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_satispay"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"scalapay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_scalapay"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"kakao_pay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_flows_private_payment_methods_kakao_pay_payment_method_options"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"mobilepay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_mobilepay"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"naver_pay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_flows_private_payment_methods_naver_pay_payment_method_options"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"promptpay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_promptpay"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"acss_debit": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_acss_debit"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"amazon_pay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_amazon_pay"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"bacs_debit": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_bacs_debit"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"bancontact": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_bancontact"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"multibanco": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_multibanco"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"sepa_debit": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_sepa_debit"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"wechat_pay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_wechat_pay"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"pay_by_bank": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_pay_by_bank"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"revolut_pay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_revolut_pay"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"samsung_pay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_flows_private_payment_methods_samsung_pay_payment_method_options"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"card_present": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_card_present"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"au_becs_debit": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_au_becs_debit"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"interac_present": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_interac_present"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"nz_bank_account": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_nz_bank_account"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"us_bank_account": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_us_bank_account"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"customer_balance": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_customer_balance"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"afterpay_clearpay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_afterpay_clearpay"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
}
},
"description": "",
"x-expandableFields": [
"acss_debit",
"affirm",
"afterpay_clearpay",
"alipay",
"alma",
"amazon_pay",
"au_becs_debit",
"bacs_debit",
"bancontact",
"billie",
"bizum",
"blik",
"boleto",
"card",
"card_present",
"cashapp",
"crypto",
"customer_balance",
"eps",
"fpx",
"giropay",
"grabpay",
"ideal",
"interac_present",
"kakao_pay",
"klarna",
"konbini",
"kr_card",
"link",
"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",
"scalapay",
"sepa_debit",
"sofort",
"sunbit",
"swish",
"twint",
"upi",
"us_bank_account",
"wechat_pay",
"zip"
]
}
payment_intent_payment_method_options_acss_debit
{
"type": "object",
"title": "payment_intent_payment_method_options_acss_debit",
"properties": {
"target_date": {
"type": "string",
"maxLength": 5000,
"description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."
},
"mandate_options": {
"$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_acss_debit"
},
"setup_future_usage": {
"enum": [
"none",
"off_session",
"on_session"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
},
"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"
]
}
payment_intent_payment_method_options_au_becs_debit
{
"type": "object",
"title": "payment_intent_payment_method_options_au_becs_debit",
"properties": {
"target_date": {
"type": "string",
"maxLength": 5000,
"description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."
},
"setup_future_usage": {
"enum": [
"none",
"off_session",
"on_session"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_payment_method_options_bacs_debit
{
"type": "object",
"title": "payment_intent_payment_method_options_bacs_debit",
"properties": {
"target_date": {
"type": "string",
"maxLength": 5000,
"description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."
},
"mandate_options": {
"$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_bacs_debit"
},
"setup_future_usage": {
"enum": [
"none",
"off_session",
"on_session"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
}
},
"description": "",
"x-expandableFields": [
"mandate_options"
]
}
payment_intent_payment_method_options_blik
{
"type": "object",
"title": "payment_intent_payment_method_options_blik",
"properties": {
"setup_future_usage": {
"enum": [
"none"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
"x-stripeBypassValidation": true
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_payment_method_options_card
{
"type": "object",
"title": "payment_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 payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time."
},
"installments": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_card_installments"
}
],
"nullable": true,
"description": "Installment details for this payment.\n\nFor more information, see the [installments integration guide](https://docs.stripe.com/payments/installments)."
},
"capture_method": {
"enum": [
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account.",
"x-stripeBypassValidation": true
},
"mandate_options": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_card_mandate_options"
}
],
"nullable": true,
"description": "Configuration options for setting up an eMandate for cards issued in India."
},
"setup_future_usage": {
"enum": [
"none",
"off_session",
"on_session"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
},
"request_overcapture": {
"enum": [
"if_available",
"never"
],
"type": "string",
"description": "Request ability to [overcapture](https://docs.stripe.com/payments/overcapture) for this PaymentIntent."
},
"request_multicapture": {
"enum": [
"if_available",
"never"
],
"type": "string",
"description": "Request ability to make [multiple captures](https://docs.stripe.com/payments/multicapture) for this PaymentIntent."
},
"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
},
"require_cvc_recollection": {
"type": "boolean",
"description": "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter)."
},
"request_extended_authorization": {
"enum": [
"if_available",
"never"
],
"type": "string",
"description": "Request ability to [capture beyond the standard authorization validity window](https://docs.stripe.com/payments/extended-authorization) for this PaymentIntent."
},
"statement_descriptor_suffix_kana": {
"type": "string",
"maxLength": 5000,
"description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters."
},
"request_incremental_authorization": {
"enum": [
"if_available",
"never"
],
"type": "string",
"description": "Request ability to [increment the authorization](https://docs.stripe.com/payments/incremental-authorization) for this PaymentIntent."
},
"statement_descriptor_suffix_kanji": {
"type": "string",
"maxLength": 5000,
"description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters."
}
},
"description": "",
"x-expandableFields": [
"installments",
"mandate_options"
]
}
payment_intent_payment_method_options_eps
{
"type": "object",
"title": "payment_intent_payment_method_options_eps",
"properties": {
"setup_future_usage": {
"enum": [
"none"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_payment_method_options_link
{
"type": "object",
"title": "payment_intent_payment_method_options_link",
"properties": {
"capture_method": {
"enum": [
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account."
},
"setup_future_usage": {
"enum": [
"none",
"off_session"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_payment_method_options_mandate_options_acss_debit
{
"type": "object",
"title": "payment_intent_payment_method_options_mandate_options_acss_debit",
"properties": {
"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": []
}
payment_intent_payment_method_options_mandate_options_bacs_debit
{
"type": "object",
"title": "payment_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": []
}
payment_intent_payment_method_options_mandate_options_payto
{
"type": "object",
"title": "payment_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."
},
"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": []
}
payment_intent_payment_method_options_mandate_options_sepa_debit
{
"type": "object",
"title": "payment_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": []
}
payment_intent_payment_method_options_mobilepay
{
"type": "object",
"title": "payment_intent_payment_method_options_mobilepay",
"properties": {
"capture_method": {
"enum": [
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account."
},
"setup_future_usage": {
"enum": [
"none"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_payment_method_options_nz_bank_account
{
"type": "object",
"title": "payment_intent_payment_method_options_nz_bank_account",
"properties": {
"target_date": {
"type": "string",
"maxLength": 5000,
"description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."
},
"setup_future_usage": {
"enum": [
"none",
"off_session",
"on_session"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_payment_method_options_payto
{
"type": "object",
"title": "payment_intent_payment_method_options_payto",
"properties": {
"mandate_options": {
"$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_payto"
},
"setup_future_usage": {
"enum": [
"none",
"off_session"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
}
},
"description": "",
"x-expandableFields": [
"mandate_options"
]
}
payment_intent_payment_method_options_sepa_debit
{
"type": "object",
"title": "payment_intent_payment_method_options_sepa_debit",
"properties": {
"target_date": {
"type": "string",
"maxLength": 5000,
"description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."
},
"mandate_options": {
"$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_sepa_debit"
},
"setup_future_usage": {
"enum": [
"none",
"off_session",
"on_session"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
}
},
"description": "",
"x-expandableFields": [
"mandate_options"
]
}
payment_intent_payment_method_options_swish
{
"type": "object",
"title": "payment_intent_payment_method_options_swish",
"properties": {
"reference": {
"type": "string",
"nullable": true,
"maxLength": 35,
"description": "A reference for this payment to be displayed in the Swish app."
},
"setup_future_usage": {
"enum": [
"none"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_payment_method_options_us_bank_account
{
"type": "object",
"title": "payment_intent_payment_method_options_us_bank_account",
"properties": {
"target_date": {
"type": "string",
"maxLength": 5000,
"description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."
},
"mandate_options": {
"$ref": "#/components/schemas/payment_method_options_us_bank_account_mandate_options"
},
"setup_future_usage": {
"enum": [
"none",
"off_session",
"on_session"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
},
"transaction_purpose": {
"enum": [
"goods",
"other",
"services",
"unspecified"
],
"type": "string",
"description": "The purpose of the transaction."
},
"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"
]
}
payment_intent_processing
{
"type": "object",
"title": "PaymentIntentProcessing",
"required": [
"type"
],
"properties": {
"card": {
"$ref": "#/components/schemas/payment_intent_card_processing"
},
"type": {
"enum": [
"card"
],
"type": "string",
"description": "Type of the payment method for which payment is in `processing` state, one of `card`."
}
},
"description": "",
"x-expandableFields": [
"card"
]
}
payment_intent_processing_customer_notification
{
"type": "object",
"title": "PaymentIntentProcessingCustomerNotification",
"properties": {
"completes_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "If customer approval is required, they need to provide approval before this time."
},
"approval_requested": {
"type": "boolean",
"nullable": true,
"description": "Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_type_specific_payment_method_options_client
{
"type": "object",
"title": "PaymentIntentTypeSpecificPaymentMethodOptionsClient",
"properties": {
"routing": {
"$ref": "#/components/schemas/payment_method_options_card_present_routing"
},
"installments": {
"$ref": "#/components/schemas/payment_flows_installment_options"
},
"capture_method": {
"enum": [
"automatic_delayed",
"manual",
"manual_preferred"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account."
},
"mandate_options": {
"$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_payto"
},
"setup_future_usage": {
"enum": [
"none",
"off_session",
"on_session"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
},
"verification_method": {
"enum": [
"automatic",
"instant",
"microdeposits"
],
"type": "string",
"description": "Bank account verification method. The default value is `automatic`.",
"x-stripeBypassValidation": true
},
"require_cvc_recollection": {
"type": "boolean",
"description": "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter)."
},
"request_incremental_authorization_support": {
"type": "boolean",
"description": "Request ability to [increment](https://docs.stripe.com/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://docs.stripe.com/api/payment_intents/confirm) response to verify support."
}
},
"description": "",
"x-expandableFields": [
"installments",
"mandate_options",
"routing"
]
}
payment_link
{
"type": "object",
"title": "PaymentLink",
"required": [
"active",
"after_completion",
"allow_promotion_codes",
"automatic_tax",
"billing_address_collection",
"currency",
"custom_fields",
"custom_text",
"customer_creation",
"id",
"livemode",
"metadata",
"object",
"payment_method_collection",
"phone_number_collection",
"shipping_options",
"submit_type",
"tax_id_collection",
"url"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"url": {
"type": "string",
"maxLength": 5000,
"description": "The public URL that can be shared with customers."
},
"active": {
"type": "boolean",
"description": "Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated."
},
"object": {
"enum": [
"payment_link"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"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)."
},
"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
}
},
"line_items": {
"type": "object",
"title": "PaymentLinksResourceListLineItems",
"required": [
"data",
"has_more",
"object",
"url"
],
"properties": {
"url": {
"type": "string",
"maxLength": 5000,
"description": "The URL where this list can be accessed."
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/item"
},
"description": "Details about each object."
},
"object": {
"enum": [
"list"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."
},
"has_more": {
"type": "boolean",
"description": "True if this list has another page of items after this one that can be fetched."
}
},
"description": "The line items representing what is being sold.",
"x-expandableFields": [
"data"
]
},
"application": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/application"
},
{
"$ref": "#/components/schemas/deleted_application"
}
],
"nullable": true,
"description": "The ID of the Connect application that created the Payment Link.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/application"
},
{
"$ref": "#/components/schemas/deleted_application"
}
]
}
},
"custom_text": {
"$ref": "#/components/schemas/payment_links_resource_custom_text"
},
"submit_type": {
"enum": [
"auto",
"book",
"donate",
"pay",
"subscribe"
],
"type": "string",
"description": "Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button."
},
"on_behalf_of": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/account"
}
],
"nullable": true,
"description": "The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/account"
}
]
}
},
"restrictions": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_links_resource_restrictions"
}
],
"nullable": true,
"description": "Settings that restrict the usage of a payment link."
},
"automatic_tax": {
"$ref": "#/components/schemas/payment_links_resource_automatic_tax"
},
"custom_fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payment_links_resource_custom_fields"
},
"description": "Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if `ui_mode` is `custom`."
},
"transfer_data": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_links_resource_transfer_data"
}
],
"nullable": true,
"description": "The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to."
},
"optional_items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payment_links_resource_optional_item"
},
"nullable": true,
"description": "The optional items presented to the customer at checkout."
},
"name_collection": {
"$ref": "#/components/schemas/payment_links_resource_name_collection"
},
"after_completion": {
"$ref": "#/components/schemas/payment_links_resource_after_completion"
},
"inactive_message": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The custom message to be displayed to a customer when a payment link is no longer active."
},
"invoice_creation": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_links_resource_invoice_creation"
}
],
"nullable": true,
"description": "Configuration for creating invoice for payment mode payment links."
},
"managed_payments": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_pages_checkout_session_managed_payments"
}
],
"nullable": true,
"description": "Settings for Managed Payments for this Payment Link and resulting [CheckoutSessions](/api/checkout/sessions/object), [PaymentIntents](/api/payment_intents/object), [Invoices](/api/invoices/object), and [Subscriptions](/api/subscriptions/object)."
},
"shipping_options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payment_links_resource_shipping_option"
},
"description": "The shipping rate options applied to the session."
},
"customer_creation": {
"enum": [
"always",
"if_required"
],
"type": "string",
"description": "Configuration for Customer creation during checkout."
},
"subscription_data": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_links_resource_subscription_data"
}
],
"nullable": true,
"description": "When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`."
},
"tax_id_collection": {
"$ref": "#/components/schemas/payment_links_resource_tax_id_collection"
},
"consent_collection": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_links_resource_consent_collection"
}
],
"nullable": true,
"description": "When set, provides configuration to gather active consent from customers."
},
"payment_intent_data": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_links_resource_payment_intent_data"
}
],
"nullable": true,
"description": "Indicates the parameters to be passed to PaymentIntent creation during checkout."
},
"payment_method_types": {
"type": "array",
"items": {
"enum": [
"affirm",
"afterpay_clearpay",
"alipay",
"alma",
"au_becs_debit",
"bacs_debit",
"bancontact",
"billie",
"bizum",
"blik",
"boleto",
"card",
"cashapp",
"eps",
"fpx",
"giropay",
"grabpay",
"ideal",
"klarna",
"konbini",
"link",
"mb_way",
"mobilepay",
"multibanco",
"oxxo",
"p24",
"pay_by_bank",
"paynow",
"paypal",
"payto",
"pix",
"promptpay",
"satispay",
"sepa_debit",
"sofort",
"sunbit",
"swish",
"twint",
"upi",
"us_bank_account",
"wechat_pay",
"zip"
],
"type": "string",
"x-stripeBypassValidation": true
},
"nullable": true,
"description": "The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods)."
},
"allow_promotion_codes": {
"type": "boolean",
"description": "Whether user redeemable promotion codes are enabled."
},
"application_fee_amount": {
"type": "integer",
"nullable": true,
"description": "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account."
},
"payment_method_options": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_links_resource_payment_method_options"
}
],
"nullable": true,
"description": "Payment-method-specific configuration."
},
"application_fee_percent": {
"type": "number",
"nullable": true,
"description": "This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account."
},
"phone_number_collection": {
"$ref": "#/components/schemas/payment_links_resource_phone_number_collection"
},
"payment_method_collection": {
"enum": [
"always",
"if_required"
],
"type": "string",
"description": "Configuration for collecting a payment method during checkout. Defaults to `always`."
},
"billing_address_collection": {
"enum": [
"auto",
"required"
],
"type": "string",
"description": "Configuration for collecting the customer's billing address. Defaults to `auto`."
},
"shipping_address_collection": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_links_resource_shipping_address_collection"
}
],
"nullable": true,
"description": "Configuration for collecting the customer's shipping address."
}
},
"description": "A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times.\n\nWhen a customer opens a payment link it will open a new [checkout session](https://docs.stripe.com/api/checkout/sessions) to render the payment page. You can use [checkout session events](https://docs.stripe.com/api/events/types#event_types-checkout.session.completed) to track payments through payment links.\n\nRelated guide: [Payment Links API](https://docs.stripe.com/payment-links)",
"x-resourceId": "payment_link",
"x-expandableFields": [
"after_completion",
"application",
"automatic_tax",
"consent_collection",
"custom_fields",
"custom_text",
"invoice_creation",
"line_items",
"managed_payments",
"name_collection",
"on_behalf_of",
"optional_items",
"payment_intent_data",
"payment_method_options",
"phone_number_collection",
"restrictions",
"shipping_address_collection",
"shipping_options",
"subscription_data",
"tax_id_collection",
"transfer_data"
]
}
payment_links_resource_after_completion
{
"type": "object",
"title": "PaymentLinksResourceAfterCompletion",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"hosted_confirmation",
"redirect"
],
"type": "string",
"description": "The specified behavior after the purchase is complete."
},
"redirect": {
"$ref": "#/components/schemas/payment_links_resource_completion_behavior_redirect"
},
"hosted_confirmation": {
"$ref": "#/components/schemas/payment_links_resource_completion_behavior_confirmation_page"
}
},
"description": "",
"x-expandableFields": [
"hosted_confirmation",
"redirect"
]
}
payment_links_resource_automatic_tax
{
"type": "object",
"title": "PaymentLinksResourceAutomaticTax",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "If `true`, tax will be calculated automatically using the customer's location."
},
"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_links_resource_business_name
{
"type": "object",
"title": "PaymentLinksResourceBusinessName",
"required": [
"enabled",
"optional"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates whether business name collection is enabled for the payment link."
},
"optional": {
"type": "boolean",
"description": "Whether the customer is required to complete the field before checking out. Defaults to `false`."
}
},
"description": "",
"x-expandableFields": []
}
payment_links_resource_card_payment_method_options
{
"type": "object",
"title": "PaymentLinksResourceCardPaymentMethodOptions",
"properties": {
"restrictions": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_links_resource_card_restrictions"
}
],
"nullable": true,
"description": "Restrictions to apply to the card payment method. For example, you can block specific card brands."
}
},
"description": "",
"x-expandableFields": [
"restrictions"
]
}
payment_links_resource_card_restrictions
{
"type": "object",
"title": "PaymentLinksResourceCardRestrictions",
"required": [
"brands_blocked"
],
"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_links_resource_completed_sessions
{
"type": "object",
"title": "PaymentLinksResourceCompletedSessions",
"required": [
"count",
"limit"
],
"properties": {
"count": {
"type": "integer",
"description": "The current number of checkout sessions that have been completed on the payment link which count towards the `completed_sessions` restriction to be met."
},
"limit": {
"type": "integer",
"description": "The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met."
}
},
"description": "",
"x-expandableFields": []
}
payment_links_resource_completion_behavior_confirmation_page
{
"type": "object",
"title": "PaymentLinksResourceCompletionBehaviorConfirmationPage",
"properties": {
"custom_message": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The custom message that is displayed to the customer after the purchase is complete."
}
},
"description": "",
"x-expandableFields": []
}
payment_links_resource_completion_behavior_redirect
{
"type": "object",
"title": "PaymentLinksResourceCompletionBehaviorRedirect",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"maxLength": 5000,
"description": "The URL the customer will be redirected to after the purchase is complete."
}
},
"description": "",
"x-expandableFields": []
}
payment_links_resource_consent_collection
{
"type": "object",
"title": "PaymentLinksResourceConsentCollection",
"properties": {
"promotions": {
"enum": [
"auto",
"none"
],
"type": "string",
"nullable": true,
"description": "If set to `auto`, enables the collection of customer consent for promotional communications."
},
"terms_of_service": {
"enum": [
"none",
"required"
],
"type": "string",
"nullable": true,
"description": "If set to `required`, it requires cutomers to accept the terms of service before being able to pay. If set to `none`, customers won't be shown a checkbox to accept the terms of service."
},
"payment_method_reuse_agreement": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_links_resource_payment_method_reuse_agreement"
}
],
"nullable": true,
"description": "Settings related to the payment method reuse text shown in the Checkout UI."
}
},
"description": "",
"x-expandableFields": [
"payment_method_reuse_agreement"
]
}
payment_links_resource_custom_fields
{
"type": "object",
"title": "PaymentLinksResourceCustomFields",
"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_links_resource_custom_fields_text"
},
"type": {
"enum": [
"dropdown",
"numeric",
"text"
],
"type": "string",
"description": "The type of the field."
},
"label": {
"$ref": "#/components/schemas/payment_links_resource_custom_fields_label"
},
"numeric": {
"$ref": "#/components/schemas/payment_links_resource_custom_fields_numeric"
},
"dropdown": {
"$ref": "#/components/schemas/payment_links_resource_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_links_resource_custom_fields_dropdown
{
"type": "object",
"title": "PaymentLinksResourceCustomFieldsDropdown",
"required": [
"options"
],
"properties": {
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payment_links_resource_custom_fields_dropdown_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_links_resource_custom_fields_dropdown_option
{
"type": "object",
"title": "PaymentLinksResourceCustomFieldsDropdownOption",
"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_links_resource_custom_fields_label
{
"type": "object",
"title": "PaymentLinksResourceCustomFieldsLabel",
"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_links_resource_custom_fields_numeric
{
"type": "object",
"title": "PaymentLinksResourceCustomFieldsNumeric",
"properties": {
"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_links_resource_custom_fields_text
{
"type": "object",
"title": "PaymentLinksResourceCustomFieldsText",
"properties": {
"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_links_resource_custom_text
{
"type": "object",
"title": "PaymentLinksResourceCustomText",
"properties": {
"submit": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_links_resource_custom_text_position"
}
],
"nullable": true,
"description": "Custom text that should be displayed alongside the payment confirmation button."
},
"after_submit": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_links_resource_custom_text_position"
}
],
"nullable": true,
"description": "Custom text that should be displayed after the payment confirmation button."
},
"shipping_address": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_links_resource_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_links_resource_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_links_resource_custom_text_position
{
"type": "object",
"title": "PaymentLinksResourceCustomTextPosition",
"required": [
"message"
],
"properties": {
"message": {
"type": "string",
"maxLength": 1200,
"description": "Text can be up to 1200 characters in length."
}
},
"description": "",
"x-expandableFields": []
}
payment_links_resource_individual_name
{
"type": "object",
"title": "PaymentLinksResourceIndividualName",
"required": [
"enabled",
"optional"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates whether individual name collection is enabled for the payment link."
},
"optional": {
"type": "boolean",
"description": "Whether the customer is required to complete the field before checking out. Defaults to `false`."
}
},
"description": "",
"x-expandableFields": []
}
payment_links_resource_invoice_creation
{
"type": "object",
"title": "PaymentLinksResourceInvoiceCreation",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Enable creating an invoice on successful payment."
},
"invoice_data": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_links_resource_invoice_settings"
}
],
"nullable": true,
"description": "Configuration for the invoice. Default invoice values will be used if unspecified."
}
},
"description": "",
"x-expandableFields": [
"invoice_data"
]
}
payment_links_resource_invoice_settings
{
"type": "object",
"title": "PaymentLinksResourceInvoiceSettings",
"properties": {
"footer": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Footer to be 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": "A list of up to 4 custom fields to be 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_links_resource_name_collection
{
"type": "object",
"title": "PaymentLinksResourceNameCollection",
"properties": {
"business": {
"$ref": "#/components/schemas/payment_links_resource_business_name"
},
"individual": {
"$ref": "#/components/schemas/payment_links_resource_individual_name"
}
},
"description": "",
"x-expandableFields": [
"business",
"individual"
]
}
payment_links_resource_optional_item
{
"type": "object",
"title": "PaymentLinksResourceOptionalItem",
"required": [
"price",
"quantity"
],
"properties": {
"price": {
"type": "string",
"maxLength": 5000
},
"quantity": {
"type": "integer"
},
"adjustable_quantity": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_links_resource_optional_item_adjustable_quantity"
}
],
"nullable": true
}
},
"description": "",
"x-expandableFields": [
"adjustable_quantity"
]
}
payment_links_resource_optional_item_adjustable_quantity
{
"type": "object",
"title": "PaymentLinksResourceOptionalItemAdjustableQuantity",
"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."
},
"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": []
}