CheckoutSession

Represents a customer's session as they pay for one-time purchases or subscriptions through Checkout or Payment Links, including session status, payment, and customer details.

Table-Specific Information

SELECT

The component uses the Stripe API to filter the results by the following columns and operators:


Column	Supported Operators
Id	=
CustomerId	=
CustomerDetailsEmail	=
PaymentIntentId	=
PaymentLinkId	=
Status	=
SubscriptionId	=
Created	=, >, >=, <, <=
AccountId	=

The rest of the filter is executed client-side within the component.

You can select from the CheckoutSession table with the following queries:

SELECT * FROM CheckoutSession WHERE Id = '123124'
SELECT * FROM CheckoutSession WHERE CustomerId = 'cus_N8rO0qc7j1SJJ9'
SELECT * FROM CheckoutSession WHERE CustomerDetailsEmail = '[email protected]'
SELECT * FROM CheckoutSession WHERE PaymentIntentId = 'pi_sfuniew'
SELECT * FROM CheckoutSession WHERE Created >= '2024-01-01'

INSERT

To create a new checkout session, at least Mode and SuccessUrl are required. If Mode is payment or subscription, LineItemsAggregate is also required. Recurring payments are not supported in this context.

INSERT INTO CheckoutSession (Mode, SuccessUrl, LineItemsAggregate) VALUES ('payment', 'https://example.com/success', '[{\"price\":\"price_1OPuMb2eZvKYlo2CVkxTmqYN\",\"quantity\":\"23\"}]')
INSERT INTO CheckoutSession (Mode, SuccessUrl, Currency, CustomerId) VALUES ('setup', 'https://example.com/success', 'usd', 'cus_N8rO0qc7j1SJJ9')

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the Checkout session.
AfterExpirationRecoveryAllowPromotionCodes	Boolean	False		Indicates whether user-redeemable promotion codes are enabled on the recovered Checkout Sessions when this Checkout Session expires. Defaults to false.
AfterExpirationRecoveryEnabled	Boolean	False		Indicates whether a recovery URL is generated to recover this Checkout Session if it expires before a transaction is completed. The URL is attached to the Checkout Session object upon expiration.
AfterExpirationRecoveryExpiresAt	Datetime	True		The timestamp at which the recovery URL expires.
AfterExpirationRecoveryUrl	String	True		The URL that creates a new Checkout Session, copied from this expired Checkout Session, when clicked.
AllowPromotionCodes	Boolean	False		Enables user redeemable promotion codes.
AmountSubtotal	Integer	True		Total of all items before discounts or taxes are applied.
AmountTotal	Integer	True		Total of all items after discounts and taxes are applied.
AutomaticTaxEnabled	Boolean	False		Indicates whether automatic tax is enabled for the session.
AutomaticTaxStatus	String	True		The status of the most recent automated tax calculation for this session.
BillingAddressCollection	String	False		Specifies whether Checkout collects the customer's billing address. The allowed values are auto, required.
CancelUrl	String	False		If set, Checkout displays a back button and customers are directed to this URL if they decide to cancel payment and return to your website.
ClientReferenceId	String	False		A unique string used to reference the Checkout Session. This can be a customer Id, a cart Id, or something similar, and you can use it to reconcile the Session with your internal systems.
ClientSecret	String	True		Client secret to be used when initializing Stripe.js embedded checkout.
ConsentPromotions	String	True		The result of consent_collection for this session. If opt_in, the customer consents to receiving promotional communications from the merchant about this Checkout Session. The allowed values are opt_in, opt_out.
ConsentTermsOfService	String	True		The result of consent_collection for this session. If accepted, the customer in this Checkout Session has agreed to the merchant's terms of service. The allowed values are accepted.
ConsentCollection	String	False		When set, provides configuration for the Checkout Session to gather active consent from customers.
Created	Datetime	True		The time at which the object was created. Measured in seconds since the Unix epoch.
Currency	String	False		A three-letter ISO currency code.
CustomFields	String	False		Additional information collected from the customer using custom fields. Up to two fields are supported.
CustomTextAfterSubmitMessage	String	False		Custom text displayed after the payment confirmation button.
CustomTextShippingAddressMessage	String	False		Custom text displayed alongside shipping address collection.
CustomTextSubmitMessage	String	False		Custom text displayed alongside the payment confirmation button.
CustomTextTermsOfAcceptanceMessage	String	False		Custom text displayed in place of the default terms of service agreement text.
CustomerId	String	False	Customers.Id	The Id of the customer for this Session.
CustomerCreation	String	False		Configures whether a Checkout Session creates a Customer when the Checkout Session completes. The allowed values are always, if_required.
CustomerDetailsAddress	String	True		The customer's address after a completed Checkout Session.
CustomerDetailsEmail	String	True		The email associated with the Customer.
CustomerDetailsName	String	True		The customer's name after a completed Checkout Session.
CustomerDetailsPhone	String	True		The customer's phone number after a completed Checkout Session.
CustomerDetailsTaxExempt	String	True		The customer's tax exempt status after a completed Checkout Session.
CustomerDetailsTaxIds	String	True		The customer's tax Ids after a completed Checkout Session.
CustomerEmail	String	False		The email of the customer.
ExpiresAt	Datetime	False		The timestamp at which the Checkout Session expires.
InvoiceId	String	True	Invoices.Id	The Id of the invoice created by the Checkout Session.
InvoiceCreation	String	False		Details on the state of invoice creation for the Checkout Session.
Livemode	Boolean	True		Indicates whether the object is in live mode. Returns true if the object is in live mode and false if the object is in test mode.
Locale	String	False		The IETF language tag of the locale Checkout is displayed in.
Metadata	String	False		The set of key/value pairs that you can attach to the Checkout Session object.
Mode	String	False		The mode of the Checkout Session. The allowed values are payment, setup, subscription.
Object	String	True		The string representing the object's type. Objects of the same type share the same value.
PaymentIntentId	String	True	PaymentIntent.Id	The Id of the PaymentIntent for Checkout Sessions in payment mode.
PaymentLinkId	String	True	PaymentLinks.Id	The Id of the Payment Link that created this Session.
PaymentMethodCollection	String	False		Configures whether a Checkout Session should collect a payment method.
PaymentMethodTypes	String	False		A list of the types of payment methods, such as card, that this Checkout Session is allowed to accept.
PaymentMethodOptions	String	False		Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.
PaymentStatus	String	True		The payment status of the Checkout Session, one of paid, unpaid, or no_payment_required. The allowed values are no_payment_required, paid, unpaid.
PhoneNumberCollectionEnabled	Boolean	False		Indicates whether phone number collection is enabled for the session.
RecoveredFrom	String	True		The Id of the original expired Checkout Session that triggered the recovery flow.
Redaction	String	True		DEPRECATED. Redactions for the session.
SetupIntent	String	False		The Id of the SetupIntent for Checkout Sessions in setup mode.
ShippingAddressCollectionAllowedCountries	String	False		When set, provides configuration for Checkout to collect a shipping address from a customer.
ShippingCostAmountSubtotal	Integer	True		Total shipping cost before any discounts or taxes are applied.
ShippingCostAmountTax	Integer	True		Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
ShippingCostAmountTotal	Integer	True		Total shipping cost after discounts and taxes are applied.
ShippingCostShippingRate	String	True		The Id of the ShippingRate for this order.
ShippingCostTaxes	String	True		The taxes applied to the shipping rate.
ShippingDetails	String	False		Shipping information for this Checkout Session.
ShippingOptions	String	False		The shipping rate options applied to this Session.
Status	String	True		The status of the Checkout Session, one of open, complete, or expired.
SubmitType	String	False		Specifies the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the submit button. This value can only be specified on Checkout Sessions in payment mode, not on Checkout Sessions in subscription or setup mode.
SubscriptionId	String	True	Subscriptions.Id	The Id of the subscription for Checkout Sessions in subscription mode.
SuccessUrl	String	False		The URL the customer is directed to after the payment or subscription creation is successful.
TotalDetails	String	True		Tax and discount details for the computed total amount.
UiMode	String	False		The UI mode of the Session. Can be hosted (default) or custom. The allowed values are hosted, custom.
Url	String	True		The URL to the Checkout Session.
ReturnUrl	String	False		The URL to redirect the customer back to after they authenticate or cancel their payment on the payment method's app or site. This parameter is required if ui_mode is embedded and redirect-based payment methods are enabled on the session.
LineItemsAggregate	String	False		The line items purchased by the customer.
AutomaticTaxLiabilityAccount	String	False		The connected account being referenced when type is account.
AutomaticTaxLiabilityType	String	False		Type of the account referenced. The allowed values are account, self.
RedirectOnCompletion	String	False		Controls the redirect behavior of embedded sessions. This parameter applies when ui_mode is embedded. Defaults to always. The allowed values are always, if_required, never.
DiscountsAggregate	String	False		List of coupons and promotion codes attached to the Checkout Session.
PendingInvoiceItemInterval	String	True		DEPRECATED. For subscriptions with collection_method=send_invoice, the interval at which to invoice the customer.
IntegrationIdentifier	String	False		A unique identifier for tracking this session.

Pseudocolumns

Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.