API ReferenceCheckout Sessions

Complete Checkout Session

View as Markdown
Mark a checkout session as completed. Works for both User and API Key authentication. Account access is automatically validated via endpoint dependency.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

external_idstringRequired
account_idstringRequired

Response

Successful Response
idstring
Unique checkout session identifier
account_idstring
Account identifier
secure_tokenstring
Secure token for accessing the checkout session
expires_in_hoursinteger
Number of hours until the checkout session expires
completedboolean
Whether the checkout session has been completed
stateenum
Computed state of the checkout session
Allowed values:
is_expiredboolean
Whether the checkout session has expired
success_urlstring
URL to redirect to on success
return_urlstring
URL to return to on cancellation
card_tokenization_modeenum

Card tokenization mode: ‘direct’ (KMS encryption) or ‘vgs’ (VGS Collect + proxy)

Allowed values:
created_atdatetime
When the checkout session was created
updated_atdatetime
When the checkout session was last updated
customer_idstring or null
Customer identifier
customer_emailstring or null
Customer email address
line_itemslist of objects
List of line items in the checkout session
coupon_idstring or null
ID of the coupon applied to this checkout session
promotion_codestring or null
Promotion code used to apply the coupon
card_checkout_settingsobject

Settings for card checkout behavior (parallel setup, 3DS mode)

cascade_statusobject or null

Cascade pricing status (None if no cascade configured)

cascade_tierslist of objects or null

Full cascade tier details including processor routes (None if no cascade configured)

processor_route_idstring or null

ID of the processor route used for card checkout. A processor route contains an ordered list of processors tried sequentially as a fallback chain. This is a single route ID, not an array — to use multiple processors, define them within the route itself.

inline_routeobject or null

Inline processor route defined directly on this session. Contains the ordered list of processors to try as a fallback chain. Null if a predefined processor_route_id is used instead, or if no route is configured.

modeany
Checkout session mode
setup_preferencesmap from strings to any or null
Preferences for payment method setup
custom_fieldsmap from strings to any or null

Custom field values. Only included when expand=custom_fields is specified.

params_for_subobject or null
Parameters to pass to the subscription when created from this checkout session.

Errors

422
Unprocessable Entity Error