Plan Usage

Get rate-limit utilization for Claude Code Max and OpenAI Codex Pro.

GET /api/stats/plan-usage

Plan Usage

cURL

curl --request GET \
  --url https://api.example.com/api/stats/plan-usage

200

{
  "fetched_at": "2023-11-07T05:31:56Z",
  "claude": {
    "extra_usage_enabled": false,
    "extra_usage_limit_usd": 123,
    "extra_usage_used_usd": 123,
    "extra_usage_utilization_pct": 123,
    "five_hour": {
      "reset_seconds": 123,
      "resets_at": "<string>",
      "utilization_pct": 0
    },
    "message": "<string>",
    "models": [
      {
        "name": "<string>",
        "utilization_pct": 0
      }
    ],
    "plan": "max",
    "seven_day": {
      "reset_seconds": 123,
      "resets_at": "<string>",
      "utilization_pct": 0
    },
    "status": "unavailable"
  },
  "codex": {
    "credit_balance_usd": 123,
    "five_hour": {
      "reset_seconds": 123,
      "resets_at": "<string>",
      "utilization_pct": 0
    },
    "has_credits": false,
    "message": "<string>",
    "models": [
      {
        "name": "<string>",
        "utilization_pct": 0
      }
    ],
    "plan": "pro",
    "seven_day": {
      "reset_seconds": 123,
      "resets_at": "<string>",
      "utilization_pct": 0
    },
    "status": "unavailable"
  }
}

Response

200 - application/json

Successful Response

Combined plan usage for all coding subscriptions.

fetched_at · string<date-time> · required

claude · ClaudeUsage · object

Claude Code Max usage data.

Show child attributes

codex · CodexUsage · object

OpenAI Codex Pro usage data.

Show child attributes