Skip to main content
GET
Observe and reconcile an owner's original checkout

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128

Path Parameters

organization_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
checkout_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

Current observed checkout and credit reconciliation.

organization_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
checkout_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
offer
enum<string>
required
Available options:
topup,
paid
state
enum<string>
required
Available options:
open,
complete,
expired
payment_confirmed
boolean
required
url
string<uri> | null
required
Maximum string length: 8192
expires_at
string<date-time>
required
packs
integer
required
Required range: 1 <= x <= 100
credited_micros
string
required
Pattern: ^(0|[1-9][0-9]{0,18})$
revoked_micros
string
required
Pattern: ^(0|[1-9][0-9]{0,18})$
paid_until
string<date-time> | null
required
required_action
enum<string>
required

Human payment handoff. Complete the returned Checkout URL, or request a fresh billing portal URL to resolve an unpaid renewal. none includes a draft invoice awaiting automatic processing; it is not a claim of current Paid coverage. Never infer renewal success from the historical payment_confirmed flag.

Available options:
none,
complete_checkout,
open_billing_portal