checkoutupdate.md

CheckoutUpdate

Update an existing checkout session using an access token.

Fields

Field	Type	Required	Description
CustomFieldData	map[string]components.CheckoutUpdateCustomFieldData	➖	Key-value object storing custom field values.
ProductPriceID	*string	➖	ID of the product price to checkout. Must correspond to a price linked to the same product.
Amount	*int64	➖	N/A
CustomerName	*string	➖	N/A
CustomerEmail	*string	➖	N/A
CustomerBillingAddress	*components.Address	➖	N/A
CustomerTaxID	*string	➖	N/A
Metadata	map[string]components.CheckoutUpdateMetadata	➖	N/A
DiscountID	*string	➖	ID of the discount to apply to the checkout.
AllowDiscountCodes	*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.
CustomerIPAddress	*string	➖	N/A
CustomerMetadata	map[string]components.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 boolean You can store up to 50 key-value pairs.
SuccessURL	*string	➖	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.
EmbedOrigin	*string	➖	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.