checkout.md

Checkout

Checkout session data retrieved using an access token.

Fields

Field	Type	Required	Description
id	str	✔️	The ID of the object.
created_at	date	✔️	Creation timestamp of the object.
modified_at	date	✔️	Last modification timestamp of the object.
custom_field_data	Dict[str, Nullable[models.CheckoutCustomFieldData]]	➖	Key-value object storing custom field values.
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.
return_url	Nullable[str]	✔️	When set, a back button will be shown in the checkout to return to this URL.
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	int	✔️	Amount in cents, before discounts and taxes.
seats	OptionalNullable[int]	➖	Predefined number of seats (works with seat-based pricing only)
min_seats	OptionalNullable[int]	➖	Minimum number of seats (works with seat-based pricing only)
max_seats	OptionalNullable[int]	➖	Maximum number of seats (works with seat-based pricing only)
discount_amount	int	✔️	Discount amount in cents.
net_amount	int	✔️	Amount in cents, after discounts but before taxes.
tax_amount	Nullable[int]	✔️	Sales tax amount in cents. If null, it means there is no enough information yet to calculate it.
tax_behavior	Nullable[models.TaxBehavior]	✔️	Tax behavior of the checkout. inclusive means the price includes tax, exclusive means tax is added on top. If null, tax is not yet calculated.
total_amount	int	✔️	Amount in cents, after discounts and taxes.
currency	str	✔️	Currency code of the checkout session.
allow_trial	Nullable[bool]	✔️	Whether to enable the trial period for the checkout session. If false, the trial period will be disabled, even if the selected product has a trial configured.
active_trial_interval	Nullable[models.TrialInterval]	✔️	Interval unit of the trial period, if any. This value is either set from the checkout, if trial_interval is set, or from the selected product.
active_trial_interval_count	Nullable[int]	✔️	Number of interval units of the trial period, if any. This value is either set from the checkout, if trial_interval_count is set, or from the selected product.
trial_end	date	✔️	End date and time of the trial period, if any.
organization_id	str	✔️	ID of the organization owning the checkout session.
product_id	Nullable[str]	✔️	ID of the product to checkout.
product_price_id	Nullable[str]	✔️	: 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.
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.
require_billing_address	bool	✔️	Whether to require the customer to fill their full billing address, instead of just the country. Customers in the US will always be required to fill their full address, regardless of this setting. If you preset the billing address, this setting will be automatically set to true.
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
is_business_customer	bool	✔️	Whether the customer is a business or an individual. If true, the customer will be required to fill their full billing address and billing name.
customer_name	Nullable[str]	✔️	Name of the customer.
customer_email	Nullable[str]	✔️	Email address of the customer.
customer_ip_address	Nullable[str]	✔️	N/A
customer_billing_name	Nullable[str]	✔️	N/A
customer_billing_address	Nullable[models.Address]	✔️	N/A
customer_tax_id	Nullable[str]	✔️	N/A
locale	OptionalNullable[str]	➖	N/A
payment_processor_metadata	Dict[str, str]	✔️	N/A
billing_address_fields	models.CheckoutBillingAddressFields	✔️	N/A
trial_interval	Nullable[models.TrialInterval]	✔️	The interval unit for the trial period.
trial_interval_count	Nullable[int]	✔️	The number of interval units for the trial period.
metadata	Dict[str, models.MetadataOutputType]	✔️	N/A
external_customer_id	Nullable[str]	✔️	ID of the customer in your system. If a matching customer exists on Polar, the resulting order will be linked to this customer. Otherwise, a new customer will be created with this external ID set.
products	List[models.CheckoutProduct]	✔️	List of products available to select.
product	Nullable[models.CheckoutProduct]	✔️	Product selected to checkout.
product_price	Nullable[models.CheckoutProductPrice]	✔️	: warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. Price of the selected product.
prices	Dict[str, List[models.CheckoutPrices]]	✔️	Mapping of product IDs to their list of prices.
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