Skip to main content
List usage by billing period

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

Query Parameters

limit
integer
default:50

Maximum number of results per page.

Required range: 1 <= x <= 100
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_to
string
Pattern: ^(?:[1-9]\d{3})-(?:0[1-9]|1[0-2])$

Response

Monthly consumption with historical policy terms.

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