Skip to main content
Get usage policy

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, comma-separated; use dots for nested fields, such as current_period.cadence. Fields: current_month, current_date, current_period, billing_timezone, billing_started, policy, governing_revision, upcoming_policies.

Response

The current usage policy and any scheduled changes.

current_month
string
required
Pattern: ^(?:[1-9]\d{3})-(?:0[1-9]|1[0-2])$
current_date
string<date>
required
current_period
object
required
billing_timezone
string
required
billing_started
boolean
required
policy
object
required
governing_revision
object | null
required
upcoming_policies
object[]
required