Skip to main content
Update usage overage 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.

Body

application/json
expected_governing_revision_id
string<uuid>
required
overage
object
required
confirmed_billing_impact
boolean
required
expected_current_month
string
Pattern: ^(?:[1-9]\d{3})-(?:0[1-9]|1[0-2])$
expected_period_start_date
string<date>

Response

Current policy after the update.

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