Skip to main content
GET
Read the owner's shared organization credit pool

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

Current organization credit balance.

organization_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
unit
string
required
Allowed value: "microcredits"
as_of
string<date-time>
required
available_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})$
spent_micros
string
required

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

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

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

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

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

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

First confirmed exhaustion in this continuous period; null while funded.

grace_expires_at
string<date-time> | null
required

Seven days after first confirmed exhaustion. Existing services and domains are retained during this grace; no automatic data deletion. Explicit project stop budgets are separate.

active_meters
string[]
required
Pattern: ^[a-z0-9_.-]{1,128}$
rate_cards
object[]
required

Published integer prices, newest first. A published rate is not proof of enabled billing; only active_meters names currently billed sources. Builds retain their accepted quote. Provider cost is a list-price basis before platform allowances, not an invoice.

Maximum array length: 4