Skip to main content
GET
Read a project's optional monthly credit budget

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

project_id
string
required

Project identifier.

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

Response

Current project budget and recorded usage.

project_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
amount_micros
string | null
required

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

Pattern: ^(0|[1-9][0-9]{0,18})$
mode
enum<string>
required
Available options:
continue,
stop
used_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})$
period_start
string<date-time>
required
period_end
string<date-time>
required
as_of
string<date-time>
required