List spend and send budgets
Returns every budget configured for the active organization, each with its resolved limits and live windowed usage.
Returns every budget configured for the active organization, each with its resolved limits and live windowed usage. The usage object reports sendsLast24h (recipient-denominated sends in the trailing 24 hours), newRecipientsLastHour (recipients addressed in the trailing hour), and accountHasComplaint (whether any complaint has been recorded, which is what drives hardStopOnComplaint). Budgets are returned in a single unpaginated data array ordered by scope; there is no cursor. Requires the budgets:read scope.
Scope: budgets:read. Send the API key as a bearer token; Scopes lists what each one reaches.
Request
Response
200 Success. Body: application/json, BudgetListResponse.
| Field | Type | Required | Description |
|---|---|---|---|
object | "list" | yes | |
data | array of Budget | yes | |
pagination | Pagination | yes |
Errors
Every error has the same body, {"error": {"type", "code", "message", "param"}}; branch on code. Errors lists every code.
| Status | Meaning |
|---|---|
400 | The request is malformed or a value is invalid (invalid_request, invalid_domain, idempotency_key_mismatch). |
401 | The API key is missing or invalid. |
403 | The key lacks the scope this endpoint needs (scope_missing) or may not do this (not_permitted). |
404 | No such resource in this account (resource_not_found). |
422 | The request is well-formed but a field failed validation (validation_failed). |
429 | Rate limit, plan limit, budget or spend cap reached (rate_limited, plan_limit_reached, budget_exceeded, spend_cap_reached). |
500 | An unexpected error; retry with backoff, then contact support (internal_error). |
List audit log events
Returns your account's audit log as a reverse-chronological (newest-first) page of control-plane events in the standard data list envelope.
Set or replace a budget
Creates or replaces the budget for a scope: account (omit scopeId), or key/agent (each requires a scopeId you own — an API key id (a UUID) for key, or an agent's id or portable agt_… id for agent).