Unique identifier for the object.
String representing the object's type. Objects of the same type share the same value.
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.
Whether user redeemable promotion codes are enabled.
The ID of the Connect application that created the Payment Link.
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.
This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
Configuration for collecting the customer's billing address. Defaults to auto.
When set, provides configuration to gather active consent from customers.
Three-letter ISO currency code, in lowercase. Must be a supported currency.
Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if ui_mode is custom.
Configuration for Customer creation during checkout.
The custom message to be displayed to a customer when a payment link is no longer active.
Configuration for creating invoice for payment mode payment links.
Optionalline_The line items representing what is being sold.
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
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.
Optionalname_The account on behalf of which to charge. See the Connect documentation for details.
Optionaloptional_The optional items presented to the customer at checkout.
Indicates the parameters to be passed to PaymentIntent creation during checkout.
Configuration for collecting a payment method during checkout. Defaults to always.
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.
Settings that restrict the usage of a payment link.
Configuration for collecting the customer's shipping address.
The shipping rate options applied to the session.
Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
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.
The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
The public URL that can be shared with customers.
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 to render the payment page. You can use checkout session events to track payments through payment links.
Related guide: Payment Links API