Update usage overage policy
curl --request PATCH \
--url http://localhost:3500/v1/usage/policy \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expected_current_month": "<string>",
"expected_governing_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"overage": {
"mode": "disallowed"
},
"confirmed_billing_impact": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expected_current_month: '<string>',
expected_governing_revision_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
overage: {mode: 'disallowed'},
confirmed_billing_impact: true
})
};
fetch('http://localhost:3500/v1/usage/policy', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/usage/policy"
payload = {
"expected_current_month": "<string>",
"expected_governing_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"overage": { "mode": "disallowed" },
"confirmed_billing_impact": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"current_month": "<string>",
"billing_timezone": "<string>",
"billing_started": true,
"policy": {
"kind": "none"
},
"governing_revision": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"effective_month": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"upcoming_policies": [
{
"effective_month": "<string>",
"policy": {
"kind": "none"
}
}
]
}{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "The billing month or governing revision changed, or no policy is configured.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Usage
Update usage overage policy
Changes current overage only. Requires the displayed month/revision and confirmation when increasing billable capacity. Cannot change quota, pricing or historical terms.
Update usage overage policy
curl --request PATCH \
--url http://localhost:3500/v1/usage/policy \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expected_current_month": "<string>",
"expected_governing_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"overage": {
"mode": "disallowed"
},
"confirmed_billing_impact": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expected_current_month: '<string>',
expected_governing_revision_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
overage: {mode: 'disallowed'},
confirmed_billing_impact: true
})
};
fetch('http://localhost:3500/v1/usage/policy', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/usage/policy"
payload = {
"expected_current_month": "<string>",
"expected_governing_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"overage": { "mode": "disallowed" },
"confirmed_billing_impact": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"current_month": "<string>",
"billing_timezone": "<string>",
"billing_started": true,
"policy": {
"kind": "none"
},
"governing_revision": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"effective_month": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"upcoming_policies": [
{
"effective_month": "<string>",
"policy": {
"kind": "none"
}
}
]
}{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "The billing month or governing revision changed, or no policy is configured.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Authorizations
ApiKeyBearerClerkSessionBearer
Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.
Headers
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
Response
Current policy after the update.
Pattern:
^(?:[1-9]\d{3})-(?:0[1-9]|1[0-2])$- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes