Skip to main content
List usage by billing period

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Query Parameters

fields
string

Return only these fields of each row, comma-separated; use dots for nested fields, such as capacity.eligible. Fields: period, period_start, period_end, unit, consumed, consumption_only, policy_cadence, allowance, overage, policy_revision_id, capacity.

limit
integer
default:50

Maximum number of results per page.

Required range: 1 <= x <= 1000
cursor
string

Opaque next_cursor from the previous page. Keep the same filters and sort; omit for the first page.

Maximum string length: 4096
period_from
string
Pattern: ^(?:[1-9]\d{3})-(?:0[1-9]|1[0-2])$
period_through
string
Pattern: ^(?:[1-9]\d{3})-(?:0[1-9]|1[0-2])$

Response

Monthly usage and current capacity.

data
object[]
required
Maximum array length: 1000
next_cursor
string | null
required
current_capacity
object
required