Skip to main content
GET
Read recent measured usage by day, 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}$

Response

Recent billed usage of the organization.

organization_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
as_of
string<date-time>
required
unit
string
required
Allowed value: "microcredits"
period
string
required

The UTC month that projects[].used_micros counts.

Pattern: ^20[0-9]{2}-(0[1-9]|1[0-2])$
from
string<date-time>
required

The start of the oldest UTC day in days.

projects
object[]
required

What each project has used so far in period, in ID order; projects without use are left out.

Maximum array length: 1000
days
object[]
required

Billed charges of the last up to 14 UTC days, oldest first.

Maximum array length: 15