20 lines (16 loc) · 18.6 KB

CheckoutLinkUpdate

Schema to update an existing checkout link.

Fields

Field	Type	Required	Description
`trial_interval`	OptionalNullable[models.TrialInterval]	➖	The interval unit for the trial period.
`trial_interval_count`	OptionalNullable[int]	➖	The number of interval units for the trial period.
`metadata`	Dict[str, models.CheckoutLinkUpdateMetadata]	➖	Key-value object allowing you to store additional information. The key must be a string with a maximum length of 40 characters. The value must be either: * A string with a maximum length of 500 characters * An integer * A floating-point number * A boolean You can store up to 50 key-value pairs.
`products`	List[str]	➖	List of products that will be available to select at checkout.
`label`	OptionalNullable[str]	➖	N/A
`allow_discount_codes`	OptionalNullable[bool]	➖	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`	OptionalNullable[bool]	➖	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`	OptionalNullable[str]	➖	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`	OptionalNullable[int]	➖	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.
`success_url`	OptionalNullable[str]	➖	URL where the customer will be redirected after a successful payment.You can add the `checkout_id={CHECKOUT_ID}` query parameter to retrieve the checkout session id.
`return_url`	OptionalNullable[str]	➖	When set, a back button will be shown in the checkout to return to this URL.