Skip to main content
GET
Read monthly measured usage by project and meter

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

Query Parameters

month
string
required
Pattern: ^20[0-9]{2}-(0[1-9]|1[0-2])$
cursor
string
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

Current posted usage for the selected UTC month and project page.

organization_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
month
string
required
Pattern: ^20[0-9]{2}-(0[1-9]|1[0-2])$
as_of
string<date-time>
required
unit
string
required
Allowed value: "microcredits"
next_cursor
string | null
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
data
object[]
required
Maximum array length: 20