CheckoutUpdatePublic
March 5, 2026 ยท View on GitHub
Update an existing checkout session using the client secret.
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
custom_field_data | Dict[str, Nullable[models.CheckoutUpdatePublicCustomFieldData]] | :heavy_minus_sign: | Key-value object storing custom field values. | |
product_id | OptionalNullable[str] | :heavy_minus_sign: | ID of the product to checkout. Must be present in the checkout's product list. | |
product_price_id | OptionalNullable[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. | |
amount | OptionalNullable[int] | :heavy_minus_sign: | N/A | |
seats | OptionalNullable[int] | :heavy_minus_sign: | Number of seats for seat-based pricing. | |
is_business_customer | OptionalNullable[bool] | :heavy_minus_sign: | N/A | |
customer_name | OptionalNullable[str] | :heavy_minus_sign: | N/A | John Doe |
customer_email | OptionalNullable[str] | :heavy_minus_sign: | N/A | |
customer_billing_name | OptionalNullable[str] | :heavy_minus_sign: | N/A | |
customer_billing_address | OptionalNullable[models.AddressInput] | :heavy_minus_sign: | N/A | |
customer_tax_id | OptionalNullable[str] | :heavy_minus_sign: | N/A | |
locale | OptionalNullable[str] | :heavy_minus_sign: | N/A | en |
discount_code | OptionalNullable[str] | :heavy_minus_sign: | Discount code to apply to the checkout. | |
allow_trial | OptionalNullable[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. |