GET /usage
This period usage, per key: budget, consumed, remaining, rate window, last used. The bill, made legible.
Parameters
This operation takes no parameters.
Responses
200— Success400— Validation error401— Missing API key403— Forbidden404— Not found409— Conflict429— Rate limited500— Internal server error
Response headers
ratelimit-limit— Messages this API key may spend in one 60-second window.ratelimit-remaining— Messages left in the current window.ratelimit-reset— Seconds until the current window resets and the budget refills.
200 body
| Field | Type | Required | Notes |
|---|---|---|---|
| account | object | yes | |
| account.bounced_30d | integer | yes | |
| account.complained_30d | integer | yes | |
| account.sent_24h | integer | yes | |
| account.sent_30d | integer | yes | |
| keys | array<object> | yes | |
| keys[].budget_per_period | integer | null | yes | |
| keys[].consumed_in_period | integer | yes | |
| keys[].consumed_in_window | integer | yes | |
| keys[].id | string | yes | |
| keys[].last_used_at | string | null | yes | |
| keys[].name | string | yes | |
| keys[].paused | boolean | yes | |
| keys[].period | "hourly" | "daily" | "monthly" | yes | |
| keys[].period_started_at | string | yes | |
| keys[].rate_ceiling_per_minute | integer | null | yes | |
| keys[].remaining | integer | null | yes | |
| keys[].resets_at | string | yes | |
| keys[].used_percent | number | null | yes | |
| period_started_at | string | yes |
Errors
Codes in the catalogue that answer with one of this operation’s error statuses. Every one of them carries a fix.
- validation_error 400
- invalid_idempotency_key 400
- invalid_cursor 400
- domain_already_exists 409
- domain_verified_elsewhere 409
- domain_not_verified 403
- account_suspended 403
- account_sandboxed 403
- trust_throttled 429
- missing_api_key 401
- session_required 401
- human_action_required 403
- csrf_origin_rejected 403
- mfa_required 401
- plan_not_purchasable 400
- trial_already_used 409
- plan_already_active 409
- term_not_on_sale 409
- subscription_active 409
- billing_customer_missing 404
- stripe_signature_invalid 400
- invalid_api_key 403
- restricted_api_key 403
- insufficient_role 403
- invite_email_mismatch 403
- already_in_account 409
- domain_scope_violation 403
- not_found 404
- session_expired 404
- idempotency_in_flight 409
- idempotency_payload_mismatch 409
- rate_ceiling_exceeded 429
- daily_quota_exceeded 429
- monthly_quota_exceeded 429
- rate_limit_exceeded 429
- approval_required 403
- trust_paused 403
- kill_switch_active 403
- internal_server_error 500
- support_ticket_not_found 404
- support_closed 409
- support_reopen_expired 409
- support_merge_conflict 409
- support_upload_rejected 400
- support_rate_limited 429