Skip to main content
Update usage overage policy

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.

Body

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

Response

Current policy after the update.

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