API · usage

Retrieve usage

GET /api/v2/usage

Authorization

emails:read. Use a workspace-scoped bearer key or an authorized user session.

Parameters

All resource access is checked against the selected workspace and user permissions.

Request

Set INBOXIT_API_KEY in your server environment. The CLI can also use an authenticated user session.

Example

curl -X GET 'https://inboxit.wtf/api/v2/usage' \
  -H "Authorization: Bearer $INBOXIT_API_KEY"

CLI equivalent

Use INBOXIT_TOKEN for a scoped key, or inboxit login for a user session.

Example

inboxit usage get

Response

HTTP 200. Example values are illustrative; excerpts are marked.

Example

{
  "plan": "free",
  "name": "Free",
  "domain_limit": 1,
  "daily_limit": 100,
  "monthly_limit": 1000,
  "incoming_limit": 1000,
  "storage_limit": 104857600,
  "retention_days": 7,
  "inbox_limit": null,
  "price": 0,
  "daily_used": 0,
  "monthly_used": 0,
  "incoming_used": 0,
  "sending_paused": false,
  "pause_reason": null,
  "mode": "native"
}

Behavior & errors

Account-wide, shared across workspaces. Counters use UTC day/month. Outgoing counts submitted rows, not only successful delivery. Incoming allowance is separate. null inbox_limit means unlimited. Does not return current storage bytes or invoices. Common errors: 400 invalid input, 401 unauthenticated, 403 insufficient permission, 404 missing/inaccessible resource, 409 conflict, 429 rate/usage limit, 503 service unavailable. See Errors & retries for recovery guidance.