checkoutpublicconfirmed.md

CheckoutPublicConfirmed

Checkout session data retrieved using the client secret after confirmation.

It contains a customer session token to retrieve order information right after the checkout.

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.
custom_field_data	Dict[str, Nullable[models.CheckoutPublicConfirmedCustomFieldData]]	➖	Key-value object storing custom field values.
payment_processor	models.PaymentProcessor	✔️	N/A
status	Literal["confirmed"]	✔️	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	int	✔️	Amount in cents, before discounts and taxes.
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.
total_amount	int	✔️	Amount in cents, after discounts and taxes.
currency	str	✔️	Currency code of the checkout session.
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.
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
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_address	Nullable[models.Address]	✔️	N/A
customer_tax_id	Nullable[str]	✔️	N/A
payment_processor_metadata	Dict[str, str]	✔️	N/A
products	List[models.CheckoutProduct]	✔️	List of products available to select.
product	models.CheckoutProduct	✔️	Product data for a checkout session.
product_price	models.CheckoutPublicConfirmedProductPrice	✔️	Price of the selected product.
discount	Nullable[models.CheckoutPublicConfirmedDiscount]	✔️	N/A
organization	models.Organization	✔️	N/A
attached_custom_fields	List[models.AttachedCustomField]	✔️	N/A
customer_session_token	str	✔️	N/A
customer_billing_address_fields	models.CheckoutCustomerBillingAddressFields	✔️	N/A