CheckoutUpdatePublic

March 5, 2026 ยท View on GitHub

Update an existing checkout session using the client secret.

Fields

FieldTypeRequiredDescriptionExample
custom_field_dataDict[str, Nullable[models.CheckoutUpdatePublicCustomFieldData]]:heavy_minus_sign:Key-value object storing custom field values.
product_idOptionalNullable[str]:heavy_minus_sign:ID of the product to checkout. Must be present in the checkout's product list.
product_price_idOptionalNullable[str]:heavy_minus_sign:: 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.
amountOptionalNullable[int]:heavy_minus_sign:N/A
seatsOptionalNullable[int]:heavy_minus_sign:Number of seats for seat-based pricing.
is_business_customerOptionalNullable[bool]:heavy_minus_sign:N/A
customer_nameOptionalNullable[str]:heavy_minus_sign:N/AJohn Doe
customer_emailOptionalNullable[str]:heavy_minus_sign:N/A
customer_billing_nameOptionalNullable[str]:heavy_minus_sign:N/A
customer_billing_addressOptionalNullable[models.AddressInput]:heavy_minus_sign:N/A
customer_tax_idOptionalNullable[str]:heavy_minus_sign:N/A
localeOptionalNullable[str]:heavy_minus_sign:N/Aen
discount_codeOptionalNullable[str]:heavy_minus_sign:Discount code to apply to the checkout.
allow_trialOptionalNullable[Literal[False]]:heavy_minus_sign:Disable the trial period for the checkout session. It's mainly useful when the trial is blocked because the customer already redeemed one.