statshawk
ApiAccount

GET /v1/account/usage — current plan, period usage, and analysis access.

Unmetered by design. A valid credential always receives 200, including when the account is already over its hard cap.

GET
/v1/account/usage

Unmetered by design. A valid credential always receives 200, including when the account is already over its hard cap.

Authorization

X-API-Key<token>

Raw API key (sk_live_… or sk_test_…). Preferred for REST clients. Keys are read-only; the environment prefix is the only key role. See https://statshawk.ai/docs/getting-started/permissions

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/account/usage"
{
  "data": {
    "analysis_unlocked": true,
    "configured_tier": "hobby",
    "period_reset": "2026-10-01T00:00:00Z",
    "reason": "billing_incomplete",
    "tier": "hobby",
    "units_limit": 25000,
    "units_remaining": 20800,
    "units_used": 4200,
    "upgrade_url": "https://app.statshawk.ai/billing"
  },
  "meta": {
    "cache": "HIT",
    "fetched_at": "2025-10-15T18:30:00Z",
    "request_id": "266ea41d-adf5-480b-af50-15b940c2b846",
    "source": "postgres",
    "version": "v1"
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "property1": null,
    "property2": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "property1": null,
    "property2": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "property1": null,
    "property2": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "property1": null,
    "property2": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "property1": null,
    "property2": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "property1": null,
    "property2": null
  }
}