Skip to main content
GET
Get the org's metering usage for the current billing period

Authorizations

Authorization
string
header
required

A whk_-prefixed API key (opaque; not a JWT).

Response

Success.

periodStart
string<date-time>
required
periodEnd
string<date-time> | null
required
capKind
enum<string>
required
Available options:
lifetime,
billing_cycle
events
integer
required
Required range: 0 <= x <= 9007199254740991
eventCap
integer | null
required
Required range: 0 <= x <= 9007199254740991
pausePolicy
enum<string>
required
Available options:
pause,
allow
paused
boolean
required