CheckoutLink

Checkout link data.

Fields

Field	Type	Required	Description	Example
id	str	:heavy_check_mark:	The ID of the object.
created_at	date	:heavy_check_mark:	Creation timestamp of the object.
modified_at	date	:heavy_check_mark:	Last modification timestamp of the object.
trial_interval	Nullable[models.TrialInterval]	:heavy_check_mark:	The interval unit for the trial period.
trial_interval_count	Nullable[int]	:heavy_check_mark:	The number of interval units for the trial period.
metadata	Dict[str, models.MetadataOutputType]	:heavy_check_mark:	N/A
payment_processor	models.PaymentProcessor	:heavy_check_mark:	N/A
client_secret	str	:heavy_check_mark:	Client secret used to access the checkout link.
success_url	Nullable[str]	:heavy_check_mark:	URL where the customer will be redirected after a successful payment.
return_url	Nullable[str]	:heavy_check_mark:	When set, a back button will be shown in the checkout to return to this URL.
label	Nullable[str]	:heavy_check_mark:	Optional label to distinguish links internally
allow_discount_codes	bool	:heavy_check_mark:	Whether to allow the customer to apply discount codes. If you apply a discount through discount_id, it'll still be applied, but the customer won't be able to change it.
require_billing_address	bool	:heavy_check_mark:	Whether to require the customer to fill their full billing address, instead of just the country. Customers in the US will always be required to fill their full address, regardless of this setting.
discount_id	Nullable[str]	:heavy_check_mark:	ID of the discount to apply to the checkout. If the discount is not applicable anymore when opening the checkout link, it'll be ignored.
seats	Nullable[int]	:heavy_check_mark:	Preconfigured number of seats for seat-based pricing. When set, checkout sessions created from this link are locked to this number of seats and the customer won't be able to change it. All products on the link must use seat-based pricing and allow this number of seats. If the products no longer accommodate this value when the link is opened, it'll be ignored.
organization_id	str	:heavy_check_mark:	The organization ID.	1dbfc517-0bbf-4301-9ba8-555ca42b9737
products	List[models.CheckoutLinkProduct]	:heavy_check_mark:	N/A
discount	Nullable[models.CheckoutLinkDiscount]	:heavy_check_mark:	N/A
url	str	:heavy_check_mark:	N/A