POST /v1/payment_links

Default value: "application/x-www-form-urlencoded"

A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring Prices. There is a maximum of 10 optional items allowed on a payment link, and the existing limits on the number of line items allowed on a payment link apply to the combined number of line items and optional items. There is a maximum of 20 combined line items and optional items.

A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field.

Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the url property (example: donate.stripe.com).

Possible values:

• "subscribe"
• "auto"
• "book"
• "donate"
• "pay"

Enables user redeemable promotion codes.

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. Can only be applied when there are no line items with recurring prices.

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata. Metadata associated with this Payment Link will automatically be copied to checkout sessions created by this payment link.

Three-letter ISO currency code, in lowercase. Must be a supported currency and supported by each line item's price.

Behavior after the purchase is complete.

Possible values:

• "hosted_confirmation"
• "redirect"

The account on behalf of which to charge.

Configuration for collecting the customer's billing address. Defaults to auto.

Possible values:

• "auto"
• "required"

Settings that restrict the usage of a payment link.

The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.

The custom message to be displayed to a customer when a payment link is no longer active.

Collect additional information from your customer using custom fields. Up to 3 fields are supported.

Possible values:

• "custom"

Possible values:

• "numeric"
• "text"
• "dropdown"

The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.

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.

Possible values:

• "cancel"
• "create_invoice"
• "pause"

Possible values:

• "account"
• "self"

Configures whether checkout sessions created by this payment link create a Customer.

Possible values:

• "always"
• "if_required"

Controls phone number collection settings during checkout.

We recommend that you review your privacy policy and check with your legal contacts.

The shipping rate options to apply to checkout sessions created by this payment link.

Specifies which fields in the response should be expanded.

Configuration for automatic tax collection.

Possible values:

• "account"
• "self"

Configure fields to gather active consent from customers.

Possible values:

• "auto"
• "hidden"

Possible values:

• "auto"
• "none"

Possible values:

• "required"
• "none"

Configuration for collecting the customer's shipping address.

Generate a post-purchase Invoice for one-time payments.

Possible values:

• "account"
• "self"

A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in payment mode.

Possible values:

• "off_session"
• "on_session"

Possible values:

• "manual"
• "automatic"
• "automatic_async"

Controls tax ID collection during checkout.

Possible values:

• "if_supported"
• "never"

Specify whether Checkout should collect a payment method. When set to if_required, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.

Can only be set in subscription mode. Defaults to always.

If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring subscriptions with a free trial.

Possible values:

• "always"
• "if_required"

The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your payment method settings (20+ payment methods supported).

Display additional text for your customers using custom text.