# getUsage — Postify API

`GET /v1/usage`

Get plan usage. The workspace's effective plan tier and every plan meter's consumption for the current period — including `api_requests`, the meter every /v1 call consumes.

- Required scope: `analytics:read`
- Auth: `Authorization: Bearer postify_live_…` or `x-api-key` header

## Responses

- `200` — Plan + meter consumption. (schema: `Usage`)
- `401` — [`authentication_required`](https://usepostify.com/docs/api/problems/authentication-required.md), [`invalid_api_key`](https://usepostify.com/docs/api/problems/invalid-api-key.md)
- `403` — [`insufficient_scope`](https://usepostify.com/docs/api/problems/insufficient-scope.md), [`feature_not_enabled`](https://usepostify.com/docs/api/problems/feature-not-enabled.md)
- `429` — [`rate_limited`](https://usepostify.com/docs/api/problems/rate-limited.md), [`quota_exhausted`](https://usepostify.com/docs/api/problems/quota-exhausted.md)
- `500` — [`internal_error`](https://usepostify.com/docs/api/problems/internal-error.md)

Errors are RFC 9457 `application/problem+json` with a stable `code` and a `request_id`. Full schemas: [interactive reference](https://usepostify.com/docs/api-reference) · [OpenAPI spec](https://app.usepostify.com/v1/openapi.json).

## Example (curl)

```bash
curl https://app.usepostify.com/v1/usage \
  -H "Authorization: Bearer postify_live_XXXXXXXXXXXXXXXX"
```

## Example (TypeScript)

```ts
const res = await fetch("https://app.usepostify.com/v1/usage", {
  headers: {
    Authorization: `Bearer ${process.env.POSTIFY_API_KEY}`,
  },
});

if (!res.ok) {
  // RFC 9457 problem+json: branch on the stable `code`.
  const problem = await res.json();
  throw new Error(`${problem.code}: ${problem.detail ?? problem.title}`);
}
const data = await res.json();
```