checkoutupdate.md

CheckoutUpdate

Update an existing checkout session using an access token.

Fields

Field	Type	Required	Description	Example
custom_field_data	Dict[str, Nullable[models.CheckoutUpdateCustomFieldData]]	➖	Key-value object storing custom field values.
product_id	OptionalNullable[str]	➖	ID of the product to checkout. Must be present in the checkout's product list.
product_price_id	OptionalNullable[str]	➖	: warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. ID of the product price to checkout. Must correspond to a price present in the checkout's product list.
amount	OptionalNullable[int]	➖	N/A
seats	OptionalNullable[int]	➖	Number of seats for seat-based pricing.
is_business_customer	OptionalNullable[bool]	➖	N/A
customer_name	OptionalNullable[str]	➖	N/A	John Doe
customer_email	OptionalNullable[str]	➖	N/A
customer_billing_name	OptionalNullable[str]	➖	N/A
customer_billing_address	OptionalNullable[models.AddressInput]	➖	N/A
customer_tax_id	OptionalNullable[str]	➖	N/A
locale	OptionalNullable[str]	➖	N/A	en
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.CheckoutUpdateMetadata]	➖	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.
currency	OptionalNullable[models.PresentmentCurrency]	➖	N/A
discount_id	OptionalNullable[str]	➖	ID of the discount to apply to the checkout.
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. If you preset the billing address, this setting will be automatically set to true.
allow_trial	OptionalNullable[bool]	➖	Whether to enable the trial period for the checkout session. If false, the trial period will be disabled, even if the selected product has a trial configured.
customer_ip_address	OptionalNullable[str]	➖	N/A
customer_metadata	Dict[str, models.CheckoutUpdateCustomerMetadata]	➖	Key-value object allowing you to store additional information that'll be copied to the created customer. 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.
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.
embed_origin	OptionalNullable[str]	➖	If you plan to embed the checkout session, set this to the Origin of the embedding page. It'll allow the Polar iframe to communicate with the parent page.