---
title: "Usage against your plan limits"
method: GET
path: "/auth/usage"
tags: ["Auth"]
---

# Usage against your plan limits

`GET /auth/usage`

## Request

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

API-key usage against your plan limits: this minute and today (the counters the rate limiter enforces), requests refused with 429 (`rate_limited`, today and 30 days; they use no quota), this month, the last 30 days by day, by endpoint and by key (with `paused` keys beyond the plan's key limit), requests per hour today, and the signed-in website's own usage in `website`.

## Response `200`

Usage summary

## 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)

---

[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)