Skip to main content
GET
Read effective plan and monthly versus one-time credit balance

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}$

Response

Authenticated account data.

organization_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
name
string
required
workos_organization_id
string
required
plan
enum<string>
required
Available options:
free,
paid
plan_source
enum<string>
required
Available options:
free,
stripe,
granted,
manual
paid_until
string<date-time> | null
required

End of the paid coverage: the Stripe billing period plus its 14-day renewal grace, or the end of the grant; null on Free. Paid features stay available until this instant.

available_micros
string
required

Spendable credit: monthly plus one-time credit minus the open reservations, never below zero.

Pattern: ^(0|[1-9][0-9]{0,18})$
monthly_micros
string
required

The monthly credit, which ends at next_expiry; the Free allowance is 200 credits and the Paid allowance 1000 credits per period.

Pattern: ^(0|[1-9][0-9]{0,18})$
one_time_micros
string
required

Top-up, bonus and referral credit. It does not expire.

Pattern: ^(0|[1-9][0-9]{0,18})$
reserved_micros
string
required

Credit held for open builds; it is part of the monthly and one-time credit until the build settles.

Pattern: ^(0|[1-9][0-9]{0,18})$
next_expiry
string<date-time> | null
required

When the monthly credit ends and renews; null when none is left.

as_of
string<date-time>
required