Stripe: Payment links schemas

← Payment links operations · All schemas

Create a payment link — request body — body custom fields item

Field	Type	Presence	Description and constraints
$	object	Root
dropdown	object	Optional
dropdown.default_value	string	Optional	Maximum length: 100
dropdown.options	array	Required within parent
dropdown.options[]	object	Each item
dropdown.options[].label	string	Required within parent	Maximum length: 100
dropdown.options[].value	string	Required within parent	Maximum length: 100
key	string	Required within parent	Maximum length: 200
label	object	Required within parent
label.custom	string	Required within parent	Maximum length: 100
label.type	string	Required within parent	One of: custom
numeric	object	Optional
numeric.default_value	string	Optional	Maximum length: 255
numeric.maximum_length	integer	Optional
numeric.minimum_length	integer	Optional
optional	boolean	Optional
text	object	Optional
text.default_value	string	Optional	Maximum length: 255
text.maximum_length	integer	Optional
text.minimum_length	integer	Optional
type	string	Required within parent	One of: dropdown, numeric, text

Create a payment link — request body — body custom text

Field	Type	Presence	Description and constraints
$	object	Root	Display additional text for your customers using custom text. You can't set this parameter if `ui_mode` is `elements`.
after_submit	JSON	Optional
after_submit (anyOf 1)	object	Alternative
after_submit (anyOf 1).message	string	Required within parent	Maximum length: 1200
after_submit (anyOf 2)	string	Alternative	One of:
shipping_address	JSON	Optional
shipping_address (anyOf 1)	object	Alternative
shipping_address (anyOf 1).message	string	Required within parent	Maximum length: 1200
shipping_address (anyOf 2)	string	Alternative	One of:
submit	JSON	Optional
submit (anyOf 1)	object	Alternative
submit (anyOf 1).message	string	Required within parent	Maximum length: 1200
submit (anyOf 2)	string	Alternative	One of:
terms_of_service_acceptance	JSON	Optional
terms_of_service_acceptance (anyOf 1)	object	Alternative
terms_of_service_acceptance (anyOf 1).message	string	Required within parent	Maximum length: 1200
terms_of_service_acceptance (anyOf 2)	string	Alternative	One of:

Create a payment link — request body — body invoice creation

Field	Type	Presence	Description and constraints
$	object	Root	Generate a post-purchase Invoice for one-time payments.
enabled	boolean	Required within parent
invoice_data	Model	Optional	Expand Create a payment link — request body — body invoice creation invoice data

Referenced models: Create a payment link — request body — body invoice creation invoice data

Create a payment link — request body — body invoice creation invoice data

Field	Type	Presence	Description and constraints
$	object	Root
account_tax_ids	JSON	Optional
account_tax_ids (anyOf 1)	array	Alternative
account_tax_ids (anyOf 1)[]	string	Each item	Maximum length: 5000
account_tax_ids (anyOf 2)	string	Alternative	One of:
custom_fields	JSON	Optional
custom_fields (anyOf 1)	array	Alternative
custom_fields (anyOf 1)[]	object	Each item
custom_fields (anyOf 1)[].name	string	Required within parent	Maximum length: 40
custom_fields (anyOf 1)[].value	string	Required within parent	Maximum length: 140
custom_fields (anyOf 2)	string	Alternative	One of:
description	string	Optional	Maximum length: 1500
footer	string	Optional	Maximum length: 5000
issuer	object	Optional
issuer.account	string	Optional
issuer.type	string	Required within parent	One of: account, self
metadata	JSON	Optional
metadata (anyOf 1)	object	Alternative	Additional keys: see wildcard field
metadata (anyOf 1).*	string	Additional keys
metadata (anyOf 2)	string	Alternative	One of:
rendering_options	JSON	Optional
rendering_options (anyOf 1)	object	Alternative
rendering_options (anyOf 1).amount_tax_display	string	Optional	One of: , exclude_tax, include_inclusive_tax
rendering_options (anyOf 1).template	string	Optional	Maximum length: 5000
rendering_options (anyOf 2)	string	Alternative	One of:

Create a payment link — request body — body line items item price data

Field	Type	Presence	Description and constraints
$	object	Root
currency	string	Required within parent	Format: currency
product	string	Optional	Maximum length: 5000
product_data	Model	Optional	Expand Update an invoice's line item — request body — body price data product data
recurring	object	Optional
recurring.interval	string	Required within parent	One of: day, month, week, year
recurring.interval_count	integer	Optional
tax_behavior	string	Optional	One of: exclusive, inclusive, unspecified
unit_amount	integer	Optional
unit_amount_decimal	string	Optional	Format: decimal

Referenced models: Update an invoice's line item — request body — body price data product data

Create a payment link — response body

Field	Type	Presence	Description and constraints
$	object	Root	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. When 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. Related guide: [Payment Links API](https://docs.stripe.com/payment-links)
active	boolean	Required within parent	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.
after_completion	Model	Required within parent	Expand Create a payment link — response body — after completion
allow_promotion_codes	boolean	Required within parent	Whether user redeemable promotion codes are enabled.
application	JSON	Optional
application (anyOf 1)	JSON	Alternative	The ID of the Connect application that created the Payment Link.
application (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
application (anyOf 1) (anyOf 2)	Model	Alternative	Expand PostApplicationFeesIdRefund — response body — application / object: application
application (anyOf 1) (anyOf 3)	Model	Alternative	Expand Accept a quote — response body — application / value / deleted: True, object: application
application (anyOf 2)	null	Alternative
application_fee_amount	JSON	Optional
application_fee_amount (anyOf 1)	JSON	Alternative
application_fee_amount (anyOf 1) (anyOf 1)	integer	Alternative	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.
application_fee_amount (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
application_fee_amount (anyOf 2)	null	Alternative
application_fee_percent	JSON	Optional
application_fee_percent (anyOf 1)	JSON	Alternative
application_fee_percent (anyOf 1) (anyOf 1)	number	Alternative	This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
application_fee_percent (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
application_fee_percent (anyOf 2)	null	Alternative
automatic_tax	Model	Required within parent	Expand Create a payment link — response body — automatic tax
billing_address_collection	string	Required within parent	Configuration for collecting the customer's billing address. Defaults to `auto`. Known values: auto, required
consent_collection	JSON	Optional
consent_collection (anyOf 1)	JSON	Alternative	When set, provides configuration to gather active consent from customers.
consent_collection (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a payment link — response body — consent collection value payment method reuse agreement, promotions, terms of service
consent_collection (anyOf 2)	null	Alternative
currency	string	Required within parent	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). Format: currency
custom_fields	array	Required within parent	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 `elements`.
custom_fields[]	Model	Each item	Expand Create a payment link — response body — custom fields item
custom_text	Model	Required within parent	Expand Create a payment link — response body — custom text
customer_creation	string	Required within parent	Configuration for Customer creation during checkout. Known values: always, if_required
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
inactive_message	JSON	Optional
inactive_message (anyOf 1)	string	Alternative	The custom message to be displayed to a customer when a payment link is no longer active. Maximum length: 5000
inactive_message (anyOf 2)	null	Alternative
invoice_creation	JSON	Optional
invoice_creation (anyOf 1)	JSON	Alternative	Configuration for creating invoice for payment mode payment links.
invoice_creation (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a payment link — response body — invoice creation value enabled, invoice data
invoice_creation (anyOf 2)	null	Alternative
line_items	object	Optional	The line items representing what is being sold.
line_items.data	array	Required within parent	Details about each object.
line_items.data[]	Model	Each item	Expand Retrieve a quote's line items — response body — data item
line_items.has_more	boolean	Required within parent	True if this list has another page of items after this one that can be fetched.
line_items.object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Always has the value `list`. Known values: list
line_items.url	string	Required within parent	The URL where this list can be accessed. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
managed_payments	JSON	Optional
managed_payments (anyOf 1)	JSON	Alternative	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).
managed_payments (anyOf 1) (anyOf 1)	Model	Alternative	Expand Cancel a Setup Intent — response body — managed payments value enabled
managed_payments (anyOf 2)	null	Alternative
metadata	object	Required within parent	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. Additional keys: see wildcard field
metadata.*	string	Additional keys	Maximum length: 500
name_collection	Model	Optional	Expand Create a payment link — response body — name collection
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: payment_link
on_behalf_of	JSON	Optional
on_behalf_of (anyOf 1)	JSON	Alternative	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.
on_behalf_of (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
on_behalf_of (anyOf 1) (anyOf 2)	Model	Alternative	Expand Create an account — response body
on_behalf_of (anyOf 2)	null	Alternative
optional_items	JSON	Optional
optional_items (anyOf 1)	array	Alternative	The optional items presented to the customer at checkout.
optional_items (anyOf 1)[]	Model	Each item	Expand Create a payment link — response body — optional items array item
optional_items (anyOf 2)	null	Alternative
payment_intent_data	JSON	Optional
payment_intent_data (anyOf 1)	JSON	Alternative	Indicates the parameters to be passed to PaymentIntent creation during checkout.
payment_intent_data (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a payment link — response body — payment intent data value capture method, description, metadata, setup future usage, statement descriptor, statement descriptor suffix, transfer group
payment_intent_data (anyOf 2)	null	Alternative
payment_method_collection	string	Required within parent	Configuration for collecting a payment method during checkout. Defaults to `always`. Known values: always, if_required
payment_method_options	JSON	Optional
payment_method_options (anyOf 1)	JSON	Alternative	Payment-method-specific configuration.
payment_method_options (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a payment link — response body — payment method options Payment-method-specific configuration card
payment_method_options (anyOf 2)	null	Alternative
payment_method_types	JSON	Optional
payment_method_types (anyOf 1)	array	Alternative	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).
payment_method_types (anyOf 1)[]	string	Each item	Known values: 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, paypay, payto, pix, promptpay, satispay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip
payment_method_types (anyOf 2)	null	Alternative
phone_number_collection	Model	Required within parent	Expand Create a payment link — response body — phone number collection
restrictions	JSON	Optional
restrictions (anyOf 1)	JSON	Alternative	Settings that restrict the usage of a payment link.
restrictions (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a payment link — response body — restrictions Settings that restrict the usage of a payment link completed sessions
restrictions (anyOf 2)	null	Alternative
shipping_address_collection	JSON	Optional
shipping_address_collection (anyOf 1)	JSON	Alternative	Configuration for collecting the customer's shipping address.
shipping_address_collection (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a payment link — response body — shipping address collection value allowed countries
shipping_address_collection (anyOf 2)	null	Alternative
shipping_options	array	Required within parent	The shipping rate options applied to the session.
shipping_options[]	Model	Each item	Expand Create a payment link — response body — shipping options item
submit_type	string	Required within parent	Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button. Known values: auto, book, donate, pay, subscribe
subscription_data	JSON	Optional
subscription_data (anyOf 1)	JSON	Alternative	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`.
subscription_data (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a payment link — response body — subscription data value description, invoice settings, metadata, trial period days, trial settings
subscription_data (anyOf 2)	null	Alternative
tax_id_collection	Model	Required within parent	Expand Create a payment link — response body — tax id collection
transfer_data	JSON	Optional
transfer_data (anyOf 1)	JSON	Alternative	The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
transfer_data (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a payment link — response body — transfer data value amount, destination
transfer_data (anyOf 2)	null	Alternative
url	string	Required within parent	The public URL that can be shared with customers. Maximum length: 5000

Referenced models: Create an account — response body, PostApplicationFeesIdRefund — response body — application / object: application, Accept a quote — response body — application / value / deleted: True, object: application, Retrieve a quote's line items — response body — data item, Create a payment link — response body — after completion, Create a payment link — response body — automatic tax, Create a payment link — response body — consent collection value payment method reuse agreement, promotions, terms of service, Create a payment link — response body — custom fields item, Create a payment link — response body — custom text, Create a payment link — response body — invoice creation value enabled, invoice data, Create a payment link — response body — name collection, Create a payment link — response body — optional items array item, Create a payment link — response body — payment intent data value capture method, description, metadata, setup future usage, statement descriptor, statement descriptor suffix, transfer group, Create a payment link — response body — payment method options Payment-method-specific configuration card, Create a payment link — response body — phone number collection, Create a payment link — response body — restrictions Settings that restrict the usage of a payment link completed sessions, Create a payment link — response body — shipping address collection value allowed countries, Create a payment link — response body — shipping options item, Create a payment link — response body — subscription data value description, invoice settings, metadata, trial period days, trial settings, Create a payment link — response body — tax id collection, Create a payment link — response body — transfer data value amount, destination, Cancel a Setup Intent — response body — managed payments value enabled

Create a payment link — response body — after completion

Field	Type	Presence	Description and constraints
$	object	Root
hosted_confirmation	Model	Optional	Expand Create a payment link — response body — after completion hosted confirmation
redirect	Model	Optional	Expand Create a payment link — response body — after completion redirect
type	string	Required within parent	The specified behavior after the purchase is complete. Known values: hosted_confirmation, redirect

Referenced models: Create a payment link — response body — after completion hosted confirmation, Create a payment link — response body — after completion redirect

Create a payment link — response body — after completion hosted confirmation

Field	Type	Presence	Description and constraints
$	object	Root
custom_message	JSON	Optional
custom_message (anyOf 1)	string	Alternative	The custom message that is displayed to the customer after the purchase is complete. Maximum length: 5000
custom_message (anyOf 2)	null	Alternative

Create a payment link — response body — after completion redirect

Field	Type	Presence	Description and constraints
$	object	Root
url	string	Required within parent	The URL the customer will be redirected to after the purchase is complete. Maximum length: 5000

Create a payment link — response body — automatic tax

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	If `true`, tax will be calculated automatically using the customer's location.
liability	JSON	Optional
liability (anyOf 1)	JSON	Alternative	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.
liability (anyOf 1) (anyOf 1)	Model	Alternative	Expand Pay an invoice — response body — issuer
liability (anyOf 2)	null	Alternative

Referenced models: Pay an invoice — response body — issuer

Create a payment link — response body — consent collection value payment method reuse agreement, promotions, terms of service

Field	Type	Presence	Description and constraints
$	object	Root
payment_method_reuse_agreement	JSON	Optional
payment_method_reuse_agreement (anyOf 1)	JSON	Alternative	Settings related to the payment method reuse text shown in the Checkout UI.
payment_method_reuse_agreement (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a payment link — response body — consent_collection / value / payment_method_reuse_agreement, promotions, terms_of_service / payment_method_reuse_agreement / value / position: auto, hidden
payment_method_reuse_agreement (anyOf 2)	null	Alternative
promotions	JSON	Optional
promotions (anyOf 1)	string	Alternative	If set to `auto`, enables the collection of customer consent for promotional communications. Known values: auto, none
promotions (anyOf 2)	null	Alternative
terms_of_service	JSON	Optional
terms_of_service (anyOf 1)	string	Alternative	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. Known values: none, required
terms_of_service (anyOf 2)	null	Alternative

Referenced models: Create a payment link — response body — consent_collection / value / payment_method_reuse_agreement, promotions, terms_of_service / payment_method_reuse_agreement / value / position: auto, hidden

Create a payment link — response body — consent_collection / value / payment_method_reuse_agreement, promotions, terms_of_service / payment_method_reuse_agreement / value / position: auto, hidden

Field	Type	Presence	Description and constraints
$	object	Root
position	string	Required within parent	Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI. Known values: auto, hidden

Create a payment link — response body — custom fields item

Field	Type	Presence	Description and constraints
$	object	Root
dropdown	Model	Optional	Expand Create a payment link — response body — custom fields item dropdown
key	string	Required within parent	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. Maximum length: 5000
label	Model	Required within parent	Expand Create a payment link — response body — custom fields item label
numeric	Model	Optional	Expand Create a payment link — response body — custom fields item text
optional	boolean	Required within parent	Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
text	Model	Optional	Expand Create a payment link — response body — custom fields item text
type	string	Required within parent	The type of the field. Known values: dropdown, numeric, text

Referenced models: Create a payment link — response body — custom fields item dropdown, Create a payment link — response body — custom fields item label, Create a payment link — response body — custom fields item text

Create a payment link — response body — custom fields item dropdown

Field	Type	Presence	Description and constraints
$	object	Root
default_value	JSON	Optional
default_value (anyOf 1)	string	Alternative	The value that pre-fills on the payment page. Maximum length: 5000
default_value (anyOf 2)	null	Alternative
options	array	Required within parent	The options available for the customer to select. Up to 200 options allowed.
options[]	Model	Each item	Expand Create a payment link — response body — custom fields item dropdown options item

Referenced models: Create a payment link — response body — custom fields item dropdown options item

Create a payment link — response body — custom fields item dropdown options item

Field	Type	Presence	Description and constraints
$	object	Root
label	string	Required within parent	The label for the option, displayed to the customer. Up to 100 characters. Maximum length: 5000
value	string	Required within parent	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. Maximum length: 5000

Create a payment link — response body — custom fields item label

Field	Type	Presence	Description and constraints
$	object	Root
custom	JSON	Optional
custom (anyOf 1)	string	Alternative	Custom text for the label, displayed to the customer. Up to 100 characters. Maximum length: 5000
custom (anyOf 2)	null	Alternative
type	string	Required within parent	The type of the label. Known values: custom

Create a payment link — response body — custom fields item text

Field	Type	Presence	Description and constraints
$	object	Root
default_value	JSON	Optional
default_value (anyOf 1)	string	Alternative	The value that pre-fills the field on the payment page. Maximum length: 5000
default_value (anyOf 2)	null	Alternative
maximum_length	JSON	Optional
maximum_length (anyOf 1)	JSON	Alternative
maximum_length (anyOf 1) (anyOf 1)	integer	Alternative	The maximum character length constraint for the customer's input.
maximum_length (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
maximum_length (anyOf 2)	null	Alternative
minimum_length	JSON	Optional
minimum_length (anyOf 1)	JSON	Alternative
minimum_length (anyOf 1) (anyOf 1)	integer	Alternative	The minimum character length requirement for the customer's input.
minimum_length (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minimum_length (anyOf 2)	null	Alternative

Create a payment link — response body — custom text

Field	Type	Presence	Description and constraints
$	object	Root
after_submit	JSON	Optional
after_submit (anyOf 1)	JSON	Alternative	Custom text that should be displayed after the payment confirmation button.
after_submit (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a payment link — response body — custom text submit value message
after_submit (anyOf 2)	null	Alternative
shipping_address	JSON	Optional
shipping_address (anyOf 1)	JSON	Alternative	Custom text that should be displayed alongside shipping address collection.
shipping_address (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a payment link — response body — custom text submit value message
shipping_address (anyOf 2)	null	Alternative
submit	JSON	Optional
submit (anyOf 1)	JSON	Alternative	Custom text that should be displayed alongside the payment confirmation button.
submit (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a payment link — response body — custom text submit value message
submit (anyOf 2)	null	Alternative
terms_of_service_acceptance	JSON	Optional
terms_of_service_acceptance (anyOf 1)	JSON	Alternative	Custom text that should be displayed in place of the default terms of service agreement text.
terms_of_service_acceptance (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a payment link — response body — custom text submit value message
terms_of_service_acceptance (anyOf 2)	null	Alternative

Referenced models: Create a payment link — response body — custom text submit value message

Create a payment link — response body — custom text submit value message

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Text can be up to 1200 characters in length. Maximum length: 1200

Create a payment link — response body — invoice creation value enabled, invoice data

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Enable creating an invoice on successful payment.
invoice_data	JSON	Optional
invoice_data (anyOf 1)	JSON	Alternative	Configuration for the invoice. Default invoice values will be used if unspecified.
invoice_data (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a payment link — response body — invoice creation value enabled, invoice data invoice data value account tax ids, custom fields, description, footer, issuer, metadata, rendering options
invoice_data (anyOf 2)	null	Alternative

Referenced models: Create a payment link — response body — invoice creation value enabled, invoice data invoice data value account tax ids, custom fields, description, footer, issuer, metadata, rendering options

Create a payment link — response body — invoice creation value enabled, invoice data invoice data value account tax ids, custom fields, description, footer, issuer, metadata, rendering options

Field	Type	Presence	Description and constraints
$	object	Root
account_tax_ids	JSON	Optional
account_tax_ids (anyOf 1)	array	Alternative	The account tax IDs associated with the invoice.
account_tax_ids (anyOf 1)[]	JSON	Each item
account_tax_ids (anyOf 1)[] (anyOf 1)	string	Alternative	Maximum length: 5000
account_tax_ids (anyOf 1)[] (anyOf 2)	Model	Alternative	Expand Create a tax ID — response body
account_tax_ids (anyOf 1)[] (anyOf 3)	Model	Alternative	Expand Delete a tax ID — response body
account_tax_ids (anyOf 2)	null	Alternative
custom_fields	JSON	Optional
custom_fields (anyOf 1)	array	Alternative	A list of up to 4 custom fields to be displayed on the invoice.
custom_fields (anyOf 1)[]	Model	Each item	Expand Pay an invoice — response body — custom fields Custom fields displayed on the invoice item
custom_fields (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative	An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 5000
description (anyOf 2)	null	Alternative
footer	JSON	Optional
footer (anyOf 1)	string	Alternative	Footer to be displayed on the invoice. Maximum length: 5000
footer (anyOf 2)	null	Alternative
issuer	JSON	Optional
issuer (anyOf 1)	JSON	Alternative	The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
issuer (anyOf 1) (anyOf 1)	Model	Alternative	Expand Pay an invoice — response body — issuer
issuer (anyOf 2)	null	Alternative
metadata	JSON	Optional
metadata (anyOf 1)	object	Alternative	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. Additional keys: see wildcard field
metadata (anyOf 1).*	string	Additional keys	Maximum length: 500
metadata (anyOf 2)	null	Alternative
rendering_options	JSON	Optional
rendering_options (anyOf 1)	JSON	Alternative	Options for invoice PDF rendering.
rendering_options (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a Checkout Session — response body — invoice creation value enabled, invoice data invoice data rendering options Options for invoice PDF rendering amount tax display, template
rendering_options (anyOf 2)	null	Alternative

Referenced models: Pay an invoice — response body — issuer, Delete a tax ID — response body, Create a Checkout Session — response body — invoice creation value enabled, invoice data invoice data rendering options Options for invoice PDF rendering amount tax display, template, Pay an invoice — response body — custom fields Custom fields displayed on the invoice item, Create a tax ID — response body

Create a payment link — response body — name collection

Field	Type	Presence	Description and constraints
$	object	Root
business	Model	Optional	Expand Create a payment link — response body — name collection business
individual	Model	Optional	Expand Create a payment link — response body — name collection individual

Referenced models: Create a payment link — response body — name collection business, Create a payment link — response body — name collection individual

Create a payment link — response body — name collection business

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Indicates whether business name collection is enabled for the payment link.
optional	boolean	Required within parent	Whether the customer is required to complete the field before checking out. Defaults to `false`.

Create a payment link — response body — name collection individual

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Indicates whether individual name collection is enabled for the payment link.
optional	boolean	Required within parent	Whether the customer is required to complete the field before checking out. Defaults to `false`.

Create a payment link — response body — optional items array item

Field	Type	Presence	Description and constraints
$	object	Root
adjustable_quantity	JSON	Optional
adjustable_quantity (anyOf 1)	JSON	Alternative
adjustable_quantity (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a payment link — response body — optional items array item adjustable quantity value enabled, maximum, minimum
adjustable_quantity (anyOf 2)	null	Alternative
price	string	Required within parent	Maximum length: 5000
quantity	JSON	Required within parent
quantity (anyOf 1)	integer	Alternative
quantity (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Create a payment link — response body — optional items array item adjustable quantity value enabled, maximum, minimum

Create a payment link — response body — optional items array item adjustable quantity value enabled, maximum, minimum

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Set to true if the quantity can be adjusted to any non-negative integer.
maximum	JSON	Optional
maximum (anyOf 1)	JSON	Alternative
maximum (anyOf 1) (anyOf 1)	integer	Alternative	The maximum quantity of this item the customer can purchase. By default this value is 99.
maximum (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
maximum (anyOf 2)	null	Alternative
minimum	JSON	Optional
minimum (anyOf 1)	JSON	Alternative
minimum (anyOf 1) (anyOf 1)	integer	Alternative	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.
minimum (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minimum (anyOf 2)	null	Alternative

Create a payment link — response body — payment intent data value capture method, description, metadata, setup future usage, statement descriptor, statement descriptor suffix, transfer group

Field	Type	Presence	Description and constraints
$	object	Root
capture_method	JSON	Optional
capture_method (anyOf 1)	string	Alternative	Indicates when the funds will be captured from the customer's account. Known values: automatic, automatic_async, manual
capture_method (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative	An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 5000
description (anyOf 2)	null	Alternative
metadata	object	Required within parent	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on [Payment Intents](https://docs.stripe.com/api/payment_intents) generated from this payment link. Additional keys: see wildcard field
metadata.*	string	Additional keys	Maximum length: 500
setup_future_usage	JSON	Optional
setup_future_usage (anyOf 1)	string	Alternative	Indicates that you intend to make future payments with the payment method collected during checkout. Known values: off_session, on_session
setup_future_usage (anyOf 2)	null	Alternative
statement_descriptor	JSON	Optional
statement_descriptor (anyOf 1)	string	Alternative	For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Maximum length: 5000
statement_descriptor (anyOf 2)	null	Alternative
statement_descriptor_suffix	JSON	Optional
statement_descriptor_suffix (anyOf 1)	string	Alternative	For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor. Maximum length: 5000
statement_descriptor_suffix (anyOf 2)	null	Alternative
transfer_group	JSON	Optional
transfer_group (anyOf 1)	string	Alternative	A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers) for details. Maximum length: 5000
transfer_group (anyOf 2)	null	Alternative

Create a payment link — response body — payment method options Payment-method-specific configuration card

Field	Type	Presence	Description and constraints
$	object	Root
card	JSON	Optional
card (anyOf 1)	JSON	Alternative	Configuration for `card` payment methods.
card (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a payment link — response body — payment method options Payment-method-specific configuration card card Configuration for `card` payment methods restrictions
card (anyOf 2)	null	Alternative

Referenced models: Create a payment link — response body — payment method options Payment-method-specific configuration card card Configuration for `card` payment methods restrictions

Create a payment link — response body — payment method options Payment-method-specific configuration card card Configuration for `card` payment methods restrictions

Field	Type	Presence	Description and constraints
$	object	Root
restrictions	JSON	Optional
restrictions (anyOf 1)	JSON	Alternative	Restrictions to apply to the card payment method. For example, you can block specific card brands.
restrictions (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a payment link — response body — payment method options Payment-method-specific configuration card card Configuration for `card` payment methods restrictions restrictions value brands blocked
restrictions (anyOf 2)	null	Alternative

Referenced models: Create a payment link — response body — payment method options Payment-method-specific configuration card card Configuration for `card` payment methods restrictions restrictions value brands blocked

Create a payment link — response body — payment method options Payment-method-specific configuration card card Configuration for `card` payment methods restrictions restrictions value brands blocked

Field	Type	Presence	Description and constraints
$	object	Root
brands_blocked	array	Required within parent	The card brands to block. If a customer enters or selects a card belonging to a blocked brand, they can't complete the payment.
brands_blocked[]	string	Each item	Known values: american_express, discover_global_network, mastercard, visa

Create a payment link — response body — phone number collection

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	If `true`, a phone number will be collected during checkout.

Create a payment link — response body — restrictions Settings that restrict the usage of a payment link completed sessions

Field	Type	Presence	Description and constraints
$	object	Root
completed_sessions	Model	Required within parent	Expand Create a payment link — response body — restrictions Settings that restrict the usage of a payment link completed sessions completed sessions

Referenced models: Create a payment link — response body — restrictions Settings that restrict the usage of a payment link completed sessions completed sessions

Create a payment link — response body — restrictions Settings that restrict the usage of a payment link completed sessions completed sessions

Field	Type	Presence	Description and constraints
$	object	Root
count	JSON	Required within parent
count (anyOf 1)	integer	Alternative	The current number of checkout sessions that have been completed on the payment link which count towards the `completed_sessions` restriction to be met.
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
limit	JSON	Required within parent
limit (anyOf 1)	integer	Alternative	The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met.
limit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create a payment link — response body — shipping address collection value allowed countries

Field	Type	Presence	Description and constraints
$	object	Root
allowed_countries	array	Required within parent	An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`.
allowed_countries[]	string	Each item	Known values: AC, AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CV, CW, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MK, ML, MM, MN, MO, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW, ZZ

Create a payment link — response body — shipping options item

Field	Type	Presence	Description and constraints
$	object	Root
shipping_amount	JSON	Required within parent
shipping_amount (anyOf 1)	integer	Alternative	A non-negative integer in cents representing how much to charge.
shipping_amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
shipping_rate	JSON	Required within parent	The ID of the Shipping Rate to use for this shipping option.
shipping_rate (anyOf 1)	string	Alternative	Maximum length: 5000
shipping_rate (anyOf 2)	Model	Alternative	Expand Create a shipping rate — response body

Referenced models: Create a shipping rate — response body

Create a payment link — response body — subscription data value description, invoice settings, metadata, trial period days, trial settings

Field	Type	Presence	Description and constraints
$	object	Root
description	JSON	Optional
description (anyOf 1)	string	Alternative	The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. Maximum length: 5000
description (anyOf 2)	null	Alternative
invoice_settings	Model	Required within parent	Expand Create a payment link — response body — subscription data value description, invoice settings, metadata, trial period days, trial settings invoice settings
metadata	object	Required within parent	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on [Subscriptions](https://docs.stripe.com/api/subscriptions) generated from this payment link. Additional keys: see wildcard field
metadata.*	string	Additional keys	Maximum length: 500
trial_period_days	JSON	Optional
trial_period_days (anyOf 1)	JSON	Alternative
trial_period_days (anyOf 1) (anyOf 1)	integer	Alternative	Integer representing the number of trial period days before the customer is charged for the first time.
trial_period_days (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
trial_period_days (anyOf 2)	null	Alternative
trial_settings	JSON	Optional
trial_settings (anyOf 1)	JSON	Alternative	Settings related to subscription trials.
trial_settings (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a payment link — response body — subscription data value description, invoice settings, metadata, trial period days, trial settings trial settings Settings related to subscription trials end behavior
trial_settings (anyOf 2)	null	Alternative

Referenced models: Create a payment link — response body — subscription data value description, invoice settings, metadata, trial period days, trial settings invoice settings, Create a payment link — response body — subscription data value description, invoice settings, metadata, trial period days, trial settings trial settings Settings related to subscription trials end behavior

Create a payment link — response body — subscription data value description, invoice settings, metadata, trial period days, trial settings invoice settings

Field	Type	Presence	Description and constraints
$	object	Root
issuer	Model	Required within parent	Expand Pay an invoice — response body — issuer

Referenced models: Pay an invoice — response body — issuer

Create a payment link — response body — subscription data value description, invoice settings, metadata, trial period days, trial settings trial settings Settings related to subscription trials end behavior

Field	Type	Presence	Description and constraints
$	object	Root	Configures how this subscription behaves during the trial period.
end_behavior	Model	Required within parent	Expand Create a payment link — response body — subscription data value description, invoice settings, metadata, trial period days, trial settings trial settings Settings related to subscription trials end behavior end behavior

Referenced models: Create a payment link — response body — subscription data value description, invoice settings, metadata, trial period days, trial settings trial settings Settings related to subscription trials end behavior end behavior

Create a payment link — response body — subscription data value description, invoice settings, metadata, trial period days, trial settings trial settings Settings related to subscription trials end behavior end behavior

Field	Type	Presence	Description and constraints
$	object	Root	Defines how a subscription behaves when a free trial ends.
missing_payment_method	string	Required within parent	Indicates how the subscription should change when the trial ends if the user did not provide a payment method. Known values: cancel, create_invoice, pause

Create a payment link — response body — tax id collection

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	Indicates whether tax ID collection is enabled for the session.
required	string	Required within parent	Known values: if_supported, never

Create a payment link — response body — transfer data value amount, destination

Field	Type	Presence	Description and constraints
$	object	Root
amount	JSON	Optional
amount (anyOf 1)	JSON	Alternative
amount (anyOf 1) (anyOf 1)	integer	Alternative	The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
amount (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount (anyOf 2)	null	Alternative
destination	JSON	Required within parent	The connected account receiving the transfer.
destination (anyOf 1)	string	Alternative	Maximum length: 5000
destination (anyOf 2)	Model	Alternative	Expand Create an account — response body

Referenced models: Create an account — response body