Update Checkout Session from Client
Update a checkout session by client secret.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The checkout session client secret.
Body
Update an existing checkout session using the client secret.
Key-value object storing custom field values.
ID of the product to checkout. Must be present in the checkout's product list.
ID of the product price to checkout. Must correspond to a price present in the checkout's product list.
Amount to pay in cents. Only useful for custom prices, it'll be ignored for fixed and free prices.
50 < x < 99999999Name of the customer.
Email address of the customer.
Billing address of the customer.
Discount code to apply to the checkout.
Response
Checkout session data retrieved using the client secret.
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
Payment processor used.
stripe Status of the checkout session.
open, expired, confirmed, succeeded, failed Client secret used to update and complete the checkout session from the client.
URL where the customer can access the checkout session.
Expiration date and time of the checkout session.
URL where the customer will be redirected after a successful payment.
When checkout is embedded, represents the Origin of the page embedding the checkout. Used as a security measure to send messages only to the embedding page.
Amount to pay in cents. Only useful for custom prices, it'll be ignored for fixed and free prices.
50 < x < 99999999Computed tax amount to pay in cents.
Currency code of the checkout session.
Subtotal amount in cents, including discounts and before tax.
Total amount to pay in cents, including discounts and after tax.
ID of the product to checkout.
ID of the product price to checkout.
ID of the discount applied to the checkout.
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.
Whether the discount is applicable to the checkout. Typically, free and custom prices are not discountable.
Whether the product price is free, regardless of discounts.
Whether the checkout requires payment, e.g. in case of free products or discounts that cover the total amount.
Whether the checkout requires setting up a payment method, regardless of the amount, e.g. subscriptions that have first free cycles.
Whether the checkout requires a payment form, whether because of a payment or payment method setup.
Name of the customer.
Email address of the customer.
Billing address of the customer.
List of products available to select.
Product selected to checkout.
Price of the selected product.
Schema for a fixed amount discount that is applied once or forever.
Key-value object storing custom field values.
Was this page helpful?