---
title: "Get usage and quota"
method: GET
path: "/usage"
tags: ["Usage"]
---

# Get usage and quota

`GET /usage`

## Request

- Base URL: `https://next.frase.io/api/v1`
- URL: `https://next.frase.io/api/v1/usage`
- Auth: API key in header `X-API-KEY`

What each pool has used, its limit, when it refills, and what has recently been refused.

This endpoint does NOT consume a metered request, and needs no particular scope beyond a valid key. Both are deliberate: the callers who most need to read their quota are the ones who have run out, and a key holding only write scopes still has to be able to discover why its writes started failing.

Use it to pace work before a large batch, and to interpret a 429 after one.

## Query parameters

- `include_denials` boolean

## Response `200`

Current usage, limits and recent denials

- object
  - `data` object
    - `plan` string
    - `subscription_status` string
    - `subscription_blocked` boolean: True when the subscription itself blocks work, regardless of remaining quota: every pool can read healthy and every call still fail. The remedy differs from an exhausted pool - resubscribe, rather than wait for a reset or upgrade.
    - `meters` object: Consumption pools that refill when the usage window rolls. Keys: articles, audit_pages, ai_prompts, research, api_requests, hero_images, diagrams.
    - `resources` object: Standing allowances that do not refill, so they carry no resets_at. Keys: domains, seats.
    - `recent_denials` UsageDenial[]
      - `limit_type` 'burst' | 'hourly' | 'monthly' | 'entitlement' | 'subscription' | 'serp_daily'
      - `operation` string, nullable: Which pool refused, for entitlement and subscription denials.
      - `endpoint` string, nullable
      - `occurrences` integer: Denials represented, not rows: repeats for the same limit and endpoint inside a short window are collapsed and counted here.
      - `last_at` string, date-time
  - `request_id` string

## Other responses

- `401`: Authentication failed

---

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