---
title: "Your usage and billing dashboard"
method: GET
path: "/v1/usage/dashboard"
---

# Your usage and billing dashboard

`GET /v1/usage/dashboard`

## Request

- Base URL: `https://api.reqbeat.com`
- URL: `https://api.reqbeat.com/v1/usage/dashboard`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Usage & billing dashboard: per-key usage vs quota (green/amber/red),
the account's spend-cap status, an in-context 402 upgrade prompt when
either is exhausted, and the 80%-quota expansion nudge -- every number
read off the same meter enforced at request time. Not billable: reading
the dashboard must never itself cost quota.

`free_tier` reports the free allowance and how much of it this billing
month has spent (null for an account holding no free key, which neither
free wall can bind). `blocked_deliveries` counts the changes we DECIDED not
to send you since that period began, per reason: `wall_blocked` is the free
monthly change allowance, `cap_blocked` is your own spend cap. Both are
terminal and are never retried, so a non-zero count is why a watch has gone
quiet -- as distinct from nobody hiring.

## Response `200`

Successful Response

- UsageDashboardResponse
  - `keys` KeyUsageOut[], required
    - `key_id` integer, required
    - `tier` string, required
    - `used` integer, required
    - `quota` integer, required
    - `status` string, required
  - `account_used` integer, required
  - `account_hard_cap` integer, required
  - `account_soft_cap` integer, required
  - `sla_credit_units` integer, required
  - `referral_credit_units` integer, required
  - `account_status` string, required
  - `expansion_nudge_triggered` boolean, required
  - `upgrade_prompt` UpgradePromptOut, required
    - `reason` string, required
    - `upgrade_url` string, required
  - `free_tier` FreeTierAllowanceOut, required
    - `watches_used` integer, required
    - `watches_allowance` integer, required
    - `changes_used` integer, required
    - `changes_allowance` integer, required
    - `changes_wall_reached` boolean, required
  - `blocked_deliveries` BlockedDeliveriesOut, required
    - `wall_blocked` integer, required
    - `cap_blocked` integer, required
    - `since` string, date-time, required

## Other responses

- `401`: No API key was sent.
- `403`: A key was sent, but it is unknown or revoked.

---

[API](https://skmtc.dev/reqbeat/apis/reqbeat-api.md) · [All operations](https://skmtc.dev/reqbeat/apis/reqbeat-api/llms.txt) · [OpenAPI document](https://skmtc.dev/reqbeat/apis/reqbeat-api/revisions/4758e5957e8c?raw)