POST /v1/payment_links/{payment_link}

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

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.

Specifies which fields in the response should be expanded.

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"

Configuration for automatic tax collection.

Possible values:

• "account"
• "self"

Enables user redeemable promotion codes.

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.

Behavior after the purchase is complete.

Possible values:

• "hosted_confirmation"
• "redirect"

Configuration for collecting the customer's shipping address.

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

Possible values:

• "auto"
• "required"

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

Possible values:

• "account"
• "self"

Settings that restrict the usage of a payment link.

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.

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

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

Controls tax ID collection during checkout.

Possible values:

• "if_supported"
• "never"

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

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. Pass an empty string to enable dynamic payment methods that use your payment method settings.

Display additional text for your customers using custom text.

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

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:

• "account"
• "self"