checkout.md

Checkout

Checkout session data retrieved using an access token.

Fields

Field	Type	Required	Description
created_at	date	✔️	Creation timestamp of the object.
modified_at	date	✔️	Last modification timestamp of the object.
id	str	✔️	The ID of the object.
payment_processor	models.PaymentProcessor	✔️	N/A
status	models.CheckoutStatus	✔️	N/A
client_secret	str	✔️	Client secret used to update and complete the checkout session from the client.
url	str	✔️	URL where the customer can access the checkout session.
expires_at	date	✔️	Expiration date and time of the checkout session.
success_url	str	✔️	URL where the customer will be redirected after a successful payment.
embed_origin	Nullable[str]	✔️	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	Nullable[int]	✔️	N/A
tax_amount	Nullable[int]	✔️	Computed tax amount to pay in cents.
currency	Nullable[str]	✔️	Currency code of the checkout session.
subtotal_amount	Nullable[int]	✔️	Subtotal amount in cents, including discounts and before tax.
total_amount	Nullable[int]	✔️	Total amount to pay in cents, including discounts and after tax.
product_id	str	✔️	ID of the product to checkout.
product_price_id	str	✔️	ID of the product price to checkout.
discount_id	Nullable[str]	✔️	ID of the discount applied to the checkout.
allow_discount_codes	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.
is_discount_applicable	bool	✔️	Whether the discount is applicable to the checkout. Typically, free and custom prices are not discountable.
is_free_product_price	bool	✔️	Whether the product price is free, regardless of discounts.
is_payment_required	bool	✔️	Whether the checkout requires payment, e.g. in case of free products or discounts that cover the total amount.
is_payment_setup_required	bool	✔️	Whether the checkout requires setting up a payment method, regardless of the amount, e.g. subscriptions that have first free cycles.
is_payment_form_required	bool	✔️	Whether the checkout requires a payment form, whether because of a payment or payment method setup.
customer_id	Nullable[str]	✔️	N/A
customer_name	Nullable[str]	✔️	N/A
customer_email	Nullable[str]	✔️	N/A
customer_ip_address	Nullable[str]	✔️	N/A
customer_billing_address	Nullable[models.Address]	✔️	N/A
customer_tax_id	Nullable[str]	✔️	N/A
payment_processor_metadata	models.PaymentProcessorMetadata	✔️	N/A
metadata	Dict[str, models.CheckoutMetadata]	✔️	N/A
product	models.CheckoutProduct	✔️	Product data for a checkout session.
product_price	models.ProductPrice	✔️	N/A
discount	Nullable[models.CheckoutDiscount]	✔️	N/A
subscription_id	Nullable[str]	✔️	N/A
attached_custom_fields	List[models.AttachedCustomField]	✔️	N/A
customer_metadata	Dict[str, models.CustomerMetadata]	✔️	N/A
custom_field_data	Optional[models.CheckoutCustomFieldData]	➖	Key-value object storing custom field values.