---
title: "PDF report allowance this month"
method: GET
path: "/reports/usage"
tags: ["Documents"]
---

# PDF report allowance this month

`GET /reports/usage`

## Request

- Base URL: `https://api.companystack.co.uk`
- URL: `https://api.companystack.co.uk/reports/usage`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`

This calendar month's PDF report allowance, how many are used and how many remain. `source` says which plan the allowance comes from: `api` (your API plan) or `app` (your web-app plan).

## Response `200`

Allowance and use

- object
  - `allowance` integer, nullable
  - `used` integer
  - `remaining` integer, nullable
  - `source` 'api' | 'app'

## Other responses

- `401`: API key missing, malformed or revoked
- `403`: The key's plan does not include this endpoint (`code: plan_upgrade_required`, with `upgrade_url`), the key may not call it, or the key is beyond the plan's key limit after a downgrade (`code: key_limit_exceeded`: the newest keys are paused until keys are deleted or the plan upgraded)
- `429`: Per-minute or per-day limit reached (`code: rate_limited`, `window: minute|day`). Wait `Retry-After` seconds; when both windows are full the day is reported. A refused request does not count against either limit. A bulk lookup (`POST /company/bulk`) counts each company number in it as one request, so one that is more than you have left is refused whole, and the body adds `requested` and `fits`.

---

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