Attributes
- idstring
Unique identifier for the object.
- activeboolean
Whether the payment link’s
urlis active. Iffalse, customers visiting the URL will be shown a page saying that the link has been deactivated. - line_
itemsobjectExpandable The line items representing what is being sold.
- line_items.
objectstring String representing the object’s type. Objects of the same type share the same value. Always has the value
list. - line_items.
dataarray of objects Details about each object.
- line_items.
data. idstring Unique identifier for the object.
- line_items.
data. objectstring String representing the object’s type. Objects of the same type share the same value.
- line_items.
data. amount_ discountinteger Total discount amount applied. If no discounts were applied, defaults to 0.
- line_items.
data. amount_ subtotalinteger Total before any discounts or taxes are applied.
- line_items.
data. amount_ taxinteger Total tax amount applied. If no tax was applied, defaults to 0.
- line_items.
data. amount_ totalinteger Total after discounts and taxes.
- line_items.
data. currencyenum Three-letter ISO currency code, in lowercase. Must be a supported currency.
- line_items.
data. descriptionnullable string An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.
- line_items.
data. discountsnullable array of objectsExpandable The discounts applied to the line item.
- line_items.
data. discounts. amountinteger The amount discounted.
- line_items.
data. discounts. discountobject The discount applied.
- line_items.
data. discounts. discount. idstring The ID of the discount object. Discounts cannot be fetched by ID. Use
expand[]=discountsin API calls to expand discount IDs in an array. - line_items.
data. discounts. discount. objectstring String representing the object’s type. Objects of the same type share the same value.
- line_items.
data. discounts. discount. checkout_ sessionnullable string The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.
- line_items.
data. discounts. discount. couponobject Hash describing the coupon applied to create this discount.
- line_items.
data. discounts. discount. coupon. idstring Unique identifier for the object.
- line_items.
data. discounts. discount. coupon. objectstring String representing the object’s type. Objects of the same type share the same value.
- line_items.
data. discounts. discount. coupon. amount_ offnullable integer Amount (in the
currencyspecified) that will be taken off the subtotal of any invoices for this customer. - line_items.
data. discounts. discount. coupon. applies_ tonullable objectExpandable Contains information about what this coupon applies to.
- line_items.
data. discounts. discount. coupon. applies_to. productsarray of strings A list of product IDs this coupon applies to
- line_items.
data. discounts. discount. coupon. createdtimestamp Time at which the object was created. Measured in seconds since the Unix epoch.
- line_items.
data. discounts. discount. coupon. currencynullable enum If
amount_has been set, the three-letter ISO code for the currency of the amount to take off.off - line_items.
data. discounts. discount. coupon. currency_ optionsnullable objectExpandable Coupons defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
- line_items.
data. discounts. discount. coupon. currency_options. <currency>. amount_ offinteger Amount (in the
currencyspecified) that will be taken off the subtotal of any invoices for this customer.
- line_items.
data. discounts. discount. coupon. durationenum One of
forever,once, orrepeating. Describes how long a customer who applies this coupon will get the discount.Possible enum valuesforeverApplies to all charges from a subscription with this coupon applied.
onceApplies to the first charge from a subscription with this coupon applied.
repeatingApplies to charges in the first
duration_months from a subscription with this coupon applied. This value is deprecated and will be replaced in future versions of the API.in_ months - line_items.
data. discounts. discount. coupon. duration_ in_ monthsnullable integerDeprecated If
durationisrepeating, the number of months the coupon applies. Null if coupondurationisforeveroronce. - line_items.
data. discounts. discount. coupon. livemodeboolean Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - line_items.
data. discounts. discount. coupon. max_ redemptionsnullable integer Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
- line_items.
data. discounts. discount. coupon. metadatanullable object Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- line_items.
data. discounts. discount. coupon. namenullable string Name of the coupon displayed to customers on for instance invoices or receipts.
- line_items.
data. discounts. discount. coupon. percent_ offnullable float Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $100 invoice $50 instead.
- line_items.
data. discounts. discount. coupon. redeem_ bynullable timestamp Date after which the coupon can no longer be redeemed.
- line_items.
data. discounts. discount. coupon. times_ redeemedinteger Number of times this coupon has been applied to a customer.
- line_items.
data. discounts. discount. coupon. validboolean Taking account of the above properties, whether this coupon can still be applied to a customer.
- line_items.
data. discounts. discount. customernullable stringExpandable The ID of the customer associated with this discount.
- line_items.
data. discounts. discount. endnullable timestamp If the coupon has a duration of
repeating, the date that this discount will end. If the coupon has a duration ofonceorforever, this attribute will be null. - line_items.
data. discounts. discount. invoicenullable string The invoice that the discount’s coupon was applied to, if it was applied directly to a particular invoice.
- line_items.
data. discounts. discount. invoice_ itemnullable string The invoice item
id(or invoice line itemidfor invoice line items of type=‘subscription’) that the discount’s coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. - line_items.
data. discounts. discount. promotion_ codenullable stringExpandable The promotion code applied to create this discount.
- line_items.
data. discounts. discount. starttimestamp Date that the coupon was applied.
- line_items.
data. discounts. discount. subscriptionnullable string The subscription that this coupon is applied to, if it is applied to a particular subscription.
- line_items.
data. discounts. discount. subscription_ itemnullable string The subscription item that this coupon is applied to, if it is applied to a particular subscription item.
- line_items.
data. pricenullable object The price used to generate the line item.
- line_items.
data. price. idstring Unique identifier for the object.
- line_items.
data. price. objectstring String representing the object’s type. Objects of the same type share the same value.
- line_items.
data. price. activeboolean Whether the price can be used for new purchases.
- line_items.
data. price. billing_ schemeenum Describes how to compute the price per period. Either
per_orunit tiered.per_indicates that the fixed amount (specified inunit unit_oramount unit_) will be charged per unit inamount_ decimal quantity(for prices withusage_), or per unit of total usage (for prices withtype=licensed usage_).type=metered tieredindicates that the unit pricing will be computed using a tiering strategy as defined using thetiersandtiers_attributes.mode Possible enum valuesper_unit tiered - line_items.
data. price. createdtimestamp Time at which the object was created. Measured in seconds since the Unix epoch.
- line_items.
data. price. currencyenum Three-letter ISO currency code, in lowercase. Must be a supported currency.
- line_items.
data. price. currency_ optionsnullable objectExpandable Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
- line_items.
data. price. currency_options. <currency>. custom_ unit_ amountnullable object When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
- line_items.
data. price. currency_options. <currency>.custom_unit_amount. maximumnullable integer The maximum unit amount the customer can specify for this item.
- line_items.
data. price. currency_options. <currency>.custom_unit_amount. minimumnullable integer The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
- line_items.
data. price. currency_options. <currency>.custom_unit_amount. presetnullable integer The starting unit amount which can be updated by the customer.
- line_items.
data. price. currency_options. <currency>. tax_ behaviornullable enum Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of
inclusive,exclusive, orunspecified. Once specified as eitherinclusiveorexclusive, it cannot be changed.Possible enum valuesexclusiveinclusiveunspecified - line_items.
data. price. currency_options. <currency>. tiersnullable array of objectsExpandable Each element represents a pricing tier. This parameter requires
billing_to be set toscheme tiered. See also the documentation forbilling_.scheme - line_items.
data. price. currency_options. <currency>.tiers. flat_ amountnullable integer Price for the entire tier.
- line_items.
data. price. currency_options. <currency>.tiers. flat_ amount_ decimalnullable decimal string Same as
flat_, but contains a decimal value with at most 12 decimal places.amount - line_items.
data. price. currency_options. <currency>.tiers. unit_ amountnullable integer Per unit price for units relevant to the tier.
- line_items.
data. price. currency_options. <currency>.tiers. unit_ amount_ decimalnullable decimal string Same as
unit_, but contains a decimal value with at most 12 decimal places.amount - line_items.
data. price. currency_options. <currency>.tiers. up_ tonullable integer Up to and including to this quantity will be contained in the tier.
- line_items.
data. price. currency_options. <currency>. unit_ amountnullable integer The unit amount in cents to be charged, represented as a whole integer if possible. Only set if
billing_.scheme=per_ unit - line_items.
data. price. currency_options. <currency>. unit_ amount_ decimalnullable decimal string The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places. Only set if
billing_.scheme=per_ unit
- line_items.
data. price. custom_ unit_ amountnullable object When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
- line_items.
data. price. custom_unit_amount. maximumnullable integer The maximum unit amount the customer can specify for this item.
- line_items.
data. price. custom_unit_amount. minimumnullable integer The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
- line_items.
data. price. custom_unit_amount. presetnullable integer The starting unit amount which can be updated by the customer.
- line_items.
data. price. livemodeboolean Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - line_items.
data. price. lookup_ keynullable string A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
- line_items.
data. price. metadataobject Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- line_items.
data. price. nicknamenullable string A brief description of the price, hidden from customers.
- line_items.
data. price. productstringExpandable The ID of the product this price is associated with.
- line_items.
data. price. recurringnullable object The recurring components of a price such as
intervalandusage_.type - line_items.
data. price. recurring. intervalenum The frequency at which a subscription is billed. One of
day,week,monthoryear. - line_items.
data. price. recurring. interval_ countinteger The number of intervals (specified in the
intervalattribute) between subscription billings. For example,interval=monthandinterval_bills every 3 months.count=3 - line_items.
data. price. recurring. meternullable string The meter tracking the usage of a metered price
- line_items.
data. price. recurring. usage_ typeenum Configures how the quantity per period should be determined. Can be either
meteredorlicensed.licensedautomatically bills thequantityset when adding it to a subscription.meteredaggregates the total usage based on usage records. Defaults tolicensed.
- line_items.
data. price. tax_ behaviornullable enum Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of
inclusive,exclusive, orunspecified. Once specified as eitherinclusiveorexclusive, it cannot be changed.Possible enum valuesexclusiveinclusiveunspecified - line_items.
data. price. tiersnullable array of objectsExpandable Each element represents a pricing tier. This parameter requires
billing_to be set toscheme tiered. See also the documentation forbilling_.scheme - line_items.
data. price. tiers. flat_ amountnullable integer Price for the entire tier.
- line_items.
data. price. tiers. flat_ amount_ decimalnullable decimal string Same as
flat_, but contains a decimal value with at most 12 decimal places.amount - line_items.
data. price. tiers. unit_ amountnullable integer Per unit price for units relevant to the tier.
- line_items.
data. price. tiers. unit_ amount_ decimalnullable decimal string Same as
unit_, but contains a decimal value with at most 12 decimal places.amount - line_items.
data. price. tiers. up_ tonullable integer Up to and including to this quantity will be contained in the tier.
- line_items.
data. price. tiers_ modenullable enum Defines if the tiering price should be
graduatedorvolumebased. Involume-based tiering, the maximum quantity within a period determines the per unit price. Ingraduatedtiering, pricing can change as the quantity grows.Possible enum valuesgraduatedvolume - line_items.
data. price. transform_ quantitynullable object Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with
tiers.- line_items.
data. price. transform_quantity. divide_ byinteger Divide usage by this number.
- line_items.
data. price. transform_quantity. roundenum After division, either round the result
upordown.
- line_items.
data. price. typeenum One of
one_ortime recurringdepending on whether the price is for a one-time purchase or a recurring (subscription) purchase.Possible enum valuesone_time recurring - line_items.
data. price. unit_ amountnullable integer The unit amount in cents to be charged, represented as a whole integer if possible. Only set if
billing_.scheme=per_ unit - line_items.
data. price. unit_ amount_ decimalnullable decimal string The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places. Only set if
billing_.scheme=per_ unit
- line_items.
data. quantitynullable integer The quantity of products being purchased.
- line_items.
data. taxesnullable array of objectsExpandable The taxes applied to the line item.
- line_items.
data. taxes. amountinteger Amount of tax applied for this rate.
- line_items.
data. taxes. rateobject The tax rate applied.
- line_items.
data. taxes. rate. idstring Unique identifier for the object.
- line_items.
data. taxes. rate. objectstring String representing the object’s type. Objects of the same type share the same value.
- line_items.
data. taxes. rate. activeboolean Defaults to
true. When set tofalse, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. - line_items.
data. taxes. rate. countrynullable string Two-letter country code (ISO 3166-1 alpha-2).
- line_items.
data. taxes. rate. createdtimestamp Time at which the object was created. Measured in seconds since the Unix epoch.
- line_items.
data. taxes. rate. descriptionnullable string An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
- line_items.
data. taxes. rate. display_ namestring The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
- line_items.
data. taxes. rate. effective_ percentagenullable float Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product’s taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.
- line_items.
data. taxes. rate. flat_ amountnullable object The amount of the tax rate when the
rate_istype flat_. Tax rates withamount rate_type percentagecan vary based on the transaction, resulting in this field beingnull. This field exposes the amount and currency of the flat tax rate.- line_items.
data. taxes. rate. flat_amount. amountinteger Amount of the tax when the
rate_istype flat_. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).amount - line_items.
data. taxes. rate. flat_amount. currencystring Three-letter ISO currency code, in lowercase.
- line_items.
data. taxes. rate. inclusiveboolean This specifies if the tax rate is inclusive or exclusive.
- line_items.
data. taxes. rate. jurisdictionnullable string The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
- line_items.
data. taxes. rate. jurisdiction_ levelnullable enum The level of the jurisdiction that imposes this tax rate. Will be
nullfor manually defined tax rates.Possible enum valuescitycountrycountydistrictmultiplestate - line_items.
data. taxes. rate. livemodeboolean Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - line_items.
data. taxes. rate. metadatanullable object Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- line_items.
data. taxes. rate. percentagefloat Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.
- line_items.
data. taxes. rate. rate_ typenullable enum Indicates the type of tax rate applied to the taxable amount. This value can be
nullwhen no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.Possible enum valuesflat_amount A fixed amount applied as tax, regardless of the taxable amount, such as a retail delivery fee.
percentageA tax rate expressed as a percentage of the taxable amount, such as the sales tax rate in California.
- line_items.
data. taxes. rate. statenullable string ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.
- line_items.
data. taxes. rate. tax_ typenullable enum The high-level tax type, such as
vatorsales_.tax Possible enum valuesamusement_tax Amusement Tax
communications_tax Communications Tax
gstGoods and Services Tax
hstHarmonized Sales Tax
igstIntegrated Goods and Services Tax
jctJapanese Consumption Tax
lease_tax Chicago Lease Tax
pstProvincial Sales Tax
qstQuebec Sales Tax
retail_delivery_ fee Retail Delivery Fee
Show 4 more
- line_items.
data. taxes. taxability_ reasonnullable enum The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
Possible enum valuescustomer_exempt No tax is applied as the customer is exempt from tax.
not_collecting No tax is collected either because you are not registered to collect tax in this jurisdiction, or because the non-taxable product tax code (
txcd_) was used.00000000 not_subject_ to_ tax No tax is imposed on this transaction.
not_supported No tax applied. Stripe doesn’t support this jurisdiction, territory, or product.
portion_product_ exempt A portion of the price is exempt from tax.
portion_reduced_ rated A portion of the price is taxed at a reduced rate.
portion_standard_ rated A portion of the price is taxed at the standard rate.
product_exempt The product or service is nontaxable or exempt from tax.
product_exempt_ holiday The product or service is not taxed due to a sales tax holiday.
proportionally_rated The shipping cost tax rate is calculated as a weighted average of the other line items’ rates, weighted by their amounts.
Show 5 more - line_items.
data. taxes. taxable_ amountnullable integer The amount on which tax is calculated, in cents.
- line_items.
has_ moreboolean True if this list has another page of items after this one that can be fetched.
- line_items.
urlstring The URL where this list can be accessed.
- metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- urlstring
The public URL that can be shared with customers.
More attributes
- objectstring
String representing the object’s type. Objects of the same type share the same value.
- after_
completionobject Behavior after the purchase is complete.
- after_completion.
hosted_ confirmationnullable object Configuration when
type=hosted_.confirmation - after_completion.
hosted_confirmation. custom_ messagenullable string The custom message that is displayed to the customer after the purchase is complete.
- after_completion.
redirectnullable object Configuration when
type=redirect.- after_completion.
redirect. urlstring The URL the customer will be redirected to after the purchase is complete.
- after_completion.
typeenum The specified behavior after the purchase is complete.
Possible enum valueshosted_confirmation Displays a message on the hosted surface after the purchase is complete.
redirectRedirects the customer to the specified
urlafter the purchase is complete.
- allow_
promotion_ codesboolean Whether user redeemable promotion codes are enabled.
- applicationnullable stringExpandableConnect only
The ID of the Connect application that created the Payment Link.
- application_
fee_ amountnullable integerConnect only 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_ percentnullable floatConnect only This represents the percentage of the subscription invoice total that will be transferred to the application owner’s Stripe account.
- automatic_
taxobject Configuration details for automatic tax collection.
- automatic_tax.
enabledboolean If
true, tax will be calculated automatically using the customer’s location. - automatic_tax.
liabilitynullable objectConnect only 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.
- automatic_tax.
liability. accountnullable stringExpandable The connected account being referenced when
typeisaccount. - automatic_tax.
liability. typeenum Type of the account referenced.
Possible enum valuesaccountIndicates that the account being referenced is a connected account which is different from the account making the API request but related to it.
selfIndicates that the account being referenced is the account making the API request.
- billing_
address_ collectionenum Configuration for collecting the customer’s billing address. Defaults to
auto.Possible enum valuesautoCheckout will only collect the billing address when necessary. When using automatic_tax, Checkout will collect the minimum number of fields required for tax calculation.
requiredCheckout will always collect the customer’s billing address.
- consent_
collectionnullable object When set, provides configuration to gather active consent from customers.
- consent_collection.
payment_ method_ reuse_ agreementnullable object Settings related to the payment method reuse text shown in the Checkout UI.
- consent_collection.
payment_method_reuse_agreement. positionenum 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.Possible enum valuesautohidden
- consent_collection.
promotionsnullable enum If set to
auto, enables the collection of customer consent for promotional communications.Possible enum valuesautonone - consent_collection.
terms_ of_ servicenullable enum If set to
required, it requires cutomers to accept the terms of service before being able to pay. If set tonone, customers won’t be shown a checkbox to accept the terms of service.Possible enum valuesnonerequired
- currencyenum
Three-letter ISO currency code, in lowercase. Must be a supported currency.
- custom_
fieldsarray of objects Collect additional information from your customer using custom fields. Up to 3 fields are supported.
- custom_fields.
dropdownnullable object Configuration for
type=dropdownfields.- custom_fields.
dropdown. default_ valuenullable string The value that will pre-fill on the payment page.
- custom_fields.
dropdown. optionsarray of objects The options available for the customer to select. Up to 200 options allowed.
- custom_fields.
dropdown. options. labelstring The label for the option, displayed to the customer. Up to 100 characters.
- custom_fields.
dropdown. options. valuestring 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.
- custom_fields.
keystring 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.
- custom_fields.
labelobject The label for the field, displayed to the customer.
- custom_fields.
label. customnullable string Custom text for the label, displayed to the customer. Up to 50 characters.
- custom_fields.
label. typeenum The type of the label.
Possible enum valuescustomSet a custom label for the field.
- custom_fields.
numericnullable object Configuration for
type=numericfields.- custom_fields.
numeric. default_ valuenullable string The value that will pre-fill the field on the payment page.
- custom_fields.
numeric. maximum_ lengthnullable integer The maximum character length constraint for the customer’s input.
- custom_fields.
numeric. minimum_ lengthnullable integer The minimum character length requirement for the customer’s input.
- custom_fields.
optionalboolean Whether the customer is required to complete the field before completing the Checkout Session. Defaults to
false. - custom_fields.
textnullable object Configuration for
type=textfields.- custom_fields.
text. default_ valuenullable string The value that will pre-fill the field on the payment page.
- custom_fields.
text. maximum_ lengthnullable integer The maximum character length constraint for the customer’s input.
- custom_fields.
text. minimum_ lengthnullable integer The minimum character length requirement for the customer’s input.
- custom_fields.
typeenum The type of the field.
Possible enum valuesdropdownProvide a list of options for your customer to select.
numericCollect a numbers-only field from your customer.
textCollect a string field from your customer.
- custom_
textobject Display additional text for your customers using custom text.
- custom_text.
after_ submitnullable object Custom text that should be displayed after the payment confirmation button.
- custom_text.
after_submit. messagestring Text may be up to 1200 characters in length.
- custom_text.
shipping_ addressnullable object Custom text that should be displayed alongside shipping address collection.
- custom_text.
shipping_address. messagestring Text may be up to 1200 characters in length.
- custom_text.
submitnullable object Custom text that should be displayed alongside the payment confirmation button.
- custom_text.
submit. messagestring Text may be up to 1200 characters in length.
- custom_text.
terms_ of_ service_ acceptancenullable object Custom text that should be displayed in place of the default terms of service agreement text.
- custom_text.
terms_of_service_acceptance. messagestring Text may be up to 1200 characters in length.
- customer_
creationenum Configuration for Customer creation during checkout.
Possible enum valuesalwaysThe Checkout Session will always create a Customer when a Session confirmation is attempted.
if_required The Checkout Session will only create a Customer if it is required for Session confirmation. Currently, only
subscriptionmode Sessions andpaymentmode Sessions with post-purchase invoices enabled require a Customer. - inactive_
messagenullable string The custom message to be displayed to a customer when a payment link is no longer active.
- invoice_
creationnullable object Configuration for creating invoice for payment mode payment links.
- invoice_creation.
enabledboolean Enable creating an invoice on successful payment.
- invoice_creation.
invoice_ datanullable object Configuration for the invoice. Default invoice values will be used if unspecified.
- invoice_creation.
invoice_data. account_ tax_ idsnullable array of stringsExpandable The account tax IDs associated with the invoice.
- invoice_creation.
invoice_data. custom_ fieldsnullable array of objects A list of up to 4 custom fields to be displayed on the invoice.
- invoice_creation.
invoice_data. custom_fields. namestring The name of the custom field.
- invoice_creation.
invoice_data. custom_fields. valuestring The value of the custom field.
- invoice_creation.
invoice_data. descriptionnullable string An arbitrary string attached to the object. Often useful for displaying to users.
- invoice_creation.
invoice_data. nullable string Footer to be displayed on the invoice.
- invoice_creation.
invoice_data. issuernullable objectConnect only The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
- invoice_creation.
invoice_data. issuer. accountnullable stringExpandable The connected account being referenced when
typeisaccount. - invoice_creation.
invoice_data. issuer. typeenum Type of the account referenced.
Possible enum valuesaccountIndicates that the account being referenced is a connected account which is different from the account making the API request but related to it.
selfIndicates that the account being referenced is the account making the API request.
- invoice_creation.
invoice_data. metadatanullable object Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- invoice_creation.
invoice_data. rendering_ optionsnullable object Options for invoice PDF rendering.
- invoice_creation.
invoice_data. rendering_options. amount_ tax_ displaynullable string How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
- invoice_creation.
invoice_data. rendering_options. templatenullable string ID of the invoice rendering template to be used for the generated invoice.
- livemodeboolean
Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - on_
behalf_ ofnullable stringExpandableConnect only The account on behalf of which to charge. See the Connect documentation for details.
- optional_
itemsnullable array of objectsExpandable The optional items presented to the customer at checkout.
- payment_
intent_ datanullable object Indicates the parameters to be passed to PaymentIntent creation during checkout.
- payment_intent_data.
capture_ methodnullable enum Indicates when the funds will be captured from the customer’s account.
Possible enum valuesautomaticStripe automatically captures funds when the customer authorizes the payment.
automatic_async (Default) Stripe asynchronously captures funds when the customer authorizes the payment. Recommended over
capture_due to improved latency. Read the integration guide for more information.method=automatic manualPlace a hold on the funds when the customer authorizes the payment, but don’t capture the funds until later. (Not all payment methods support this.)
- payment_intent_data.
descriptionnullable string An arbitrary string attached to the object. Often useful for displaying to users.
- payment_intent_data.
metadataobject Set of key-value pairs that will set metadata on Payment Intents generated from this payment link.
- payment_intent_data.
setup_ future_ usagenullable enum Indicates that you intend to make future payments with the payment method collected during checkout.
Possible enum valuesoff_session Use
off_if your customer may or may not be present in your checkout flow.session on_session Use
on_if you intend to only reuse the payment method when your customer is present in your checkout flow.session - payment_intent_data.
statement_ descriptornullable string For a non-card payment, information about the charge that appears on the customer’s statement when this payment succeeds in creating a charge.
- payment_intent_data.
statement_ descriptor_ suffixnullable string 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.
- payment_intent_data.
transfer_ groupnullable stringConnect only A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.
- payment_
method_ collectionenum Configuration for collecting a payment method during checkout. Defaults to
always.Possible enum valuesalwaysThe Checkout Session will always collect a PaymentMethod.
if_required The Checkout Session will only collect a PaymentMethod if there is an amount due.
- payment_
method_ typesnullable array of enums 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. - phone_
number_ collectionobject Controls phone number collection settings during checkout.
- phone_number_collection.
enabledboolean If
true, a phone number will be collected during checkout.
- restrictionsnullable object
Settings that restrict the usage of a payment link.
- restrictions.
completed_ sessionsobject Configuration for the
completed_restriction type.sessions - restrictions.
completed_sessions. countinteger The current number of checkout sessions that have been completed on the payment link which count towards the
completed_restriction to be met.sessions - restrictions.
completed_sessions. limitinteger The maximum number of checkout sessions that can be completed for the
completed_restriction to be met.sessions
- shipping_
address_ collectionnullable object Configuration for collecting the customer’s shipping address.
- shipping_address_collection.
allowed_ countriesarray of enums 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.Possible enum valuesACADAEAFAGAIALAMAOAQShow 228 more
- shipping_
optionsarray of objects The shipping rate options applied to the session.
- shipping_options.
shipping_ amountinteger A non-negative integer in cents representing how much to charge.
- shipping_options.
shipping_ ratestringExpandable The ID of the Shipping Rate to use for this shipping option.
- submit_
typeenum Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
Possible enum valuesautoDefault value.
paywill used in all scenariosbookRecommended when offering bookings. Submit button includes a ‘Book’ label and URLs use the
book.hostnamestripe. com donateRecommended when accepting donations. Submit button includes a ‘Donate’ label and URLs use the
donate.hostnamestripe. com paySubmit button includes a ‘Buy’ label and URLs use the
buy.hostnamestripe. com subscribeSubmit button includes a ‘Subscribe’ label and URLs use the
buy.hostnamestripe. com - subscription_
datanullable object 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.
descriptionnullable string 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.
- subscription_data.
invoice_ settingsobject All invoices will be billed using the specified settings.
- subscription_data.
invoice_settings. issuerobjectConnect only The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
- subscription_data.
invoice_settings. issuer. accountnullable stringExpandable The connected account being referenced when
typeisaccount. - subscription_data.
invoice_settings. issuer. typeenum Type of the account referenced.
Possible enum valuesaccountIndicates that the account being referenced is a connected account which is different from the account making the API request but related to it.
selfIndicates that the account being referenced is the account making the API request.
- subscription_data.
metadataobject Set of key-value pairs that will set metadata on Subscriptions generated from this payment link.
- subscription_data.
trial_ period_ daysnullable integer Integer representing the number of trial period days before the customer is charged for the first time.
- subscription_data.
trial_ settingsnullable object Settings related to subscription trials.
- subscription_data.
trial_settings. end_ behaviorobject Defines how the subscription should behave when the user’s free trial ends.
- subscription_data.
trial_settings. end_behavior. missing_ payment_ methodenum Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
Possible enum valuescancelCancel the subscription if a payment method is not attached when the trial ends.
create_invoice Create an invoice when the trial ends, even if the user did not set up a payment method.
pausePause the subscription if a payment method is not attached when the trial ends.
- tax_
id_ collectionobject Details on the state of tax ID collection for the payment link.
- tax_id_collection.
enabledboolean Indicates whether tax ID collection is enabled for the session.
- transfer_
datanullable objectConnect only 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.
amountnullable integer The amount in cents that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
- transfer_data.
destinationstringExpandable The connected account receiving the transfer.
{ "id": "plink_1MoC3ULkdIwHu7ixZjtGpVl2", "object": "payment_link", "active": true, "after_completion": { "hosted_confirmation": { "custom_message": null }, "type": "hosted_confirmation" }, "allow_promotion_codes": false, "application_fee_amount": null, "application_fee_percent": null, "automatic_tax": { "enabled": false, "liability": null }, "billing_address_collection": "auto", "consent_collection": null, "currency": "usd", "custom_fields": [], "custom_text": { "shipping_address": null, "submit": null }, "customer_creation": "if_required", "invoice_creation": { "enabled": false, "invoice_data": { "account_tax_ids": null, "custom_fields": null, "description": null, "footer": null, "issuer": null, "metadata": {}, "rendering_options": null } }, "livemode": false, "metadata": {}, "on_behalf_of": null, "payment_intent_data": null, "payment_method_collection": "always", "payment_method_types": null, "phone_number_collection": { "enabled": false }, "shipping_address_collection": null, "shipping_options": [], "submit_type": "auto", "subscription_data": { "description": null, "invoice_settings": { "issuer": { "type": "self" } }, "trial_period_days": null }, "tax_id_collection": { "enabled": false }, "transfer_data": null, "url": "https://buy.stripe.com/test_cN25nr0iZ7bUa7meUY"}