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.

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,
beta,
manual
paid_until
string<date-time> | null
required
available_micros
string
required

Non-negative microcredits, at most 9223372036854775807. One credit equals 1000000 microcredits.

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

Non-negative microcredits, at most 9223372036854775807. One credit equals 1000000 microcredits.

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

Non-negative microcredits, at most 9223372036854775807. One credit equals 1000000 microcredits.

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

Non-negative microcredits, at most 9223372036854775807. One credit equals 1000000 microcredits.

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