Get a checkout session
Returns the current state of a checkout session, including the payment and subscription it created once the customer completes checkout. Poll this endpoint or subscribe to the checkoutsession.completed webhook event.
Authorizations
API key authentication. Pass your API key as a Bearer token.
Headers
2026-04-01 Path Parameters
Unique identifier for the checkout-session
Response
Success
Whether the session charges the customer or only stores a payment method
payment, vault "payment"
Timestamp when the session was created
"2026-04-01T10:00:00Z"
ISO 4217 currency code
"USD"
Unique identifier for the checkout session
"chks_01H1VECT"
Browser-safe token that scopes the embedded checkout to this session. Pass it to the Alguna Checkout SDK.
"elt_01H1VECT"
Checkout session status
created, started, successful, expired "created"
Hosted checkout URL for this session. The Alguna Checkout SDK embeds this URL; it can also be used directly as a redirect target.
"https://acme.alguna.io/embed/checkout/elt_01H1VECT"
Total amount for the session
"99.00"
Your reference supplied at creation
"order_1234"
Customer the checkout is for, once known
"cust_abc123"
Timestamp when the session token expires
"2026-04-02T10:00:00Z"
Invoice created by the session, once completed. One-off sessions (line_items or amount) produce a paid invoice instead of a subscription.
"inv_01H1VECT"
Payment created by the session, once completed
"pay_01H1VECT"
Subscription created by the session, once completed
"sub_01H1VECT"