---
title: "Read period allowance, used subjects and pending reservations"
method: GET
path: "/usage"
tags: ["Usage"]
---

# Read period allowance, used subjects and pending reservations

`GET /usage`

## Request

- Base URL: `https://www.sanctionskit.com/api/v1`
- URL: `https://www.sanctionskit.com/api/v1/usage`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/sanctionskit/apis/sanctionskit-api/docs/usage/get.ts> (a function with typed inputs; its response is checked against the schema)

Required API key scope: usage:read.

## Response `200`

Successful response. JSON object with the required data key. All properties marked required are present, including keys whose value may be null. Unmarked properties can be omitted; clients should tolerate additional response properties.

- object
  - `data` Usage, required
    - `environment` 'sandbox' | 'production', required
    - `period` string, required
    - `used` integer, required
    - `reserved` integer, required
    - `limit` integer, required
    - `planLimit` integer, required
    - `spendingCap` integer, required
    - `effectiveLimit` integer, required
    - `remaining` integer, required
    - `plan` string, required
    - `events` object[], required
      - `kind` string, required
      - `subjects` integer, required
    - `fileStorage` FileStorage, required
      - `plan` string, required
      - `maxBytes` integer, required
      - `usedBytes` integer, required
      - `reservedBytes` integer, required
      - `remainingBytes` integer, required
      - `sandbox` object, required
        - `maxBytes` integer, required
        - `usedBytes` integer, required
        - `reservedBytes` integer, required
        - `remainingBytes` integer, required
      - `maxBatchUploadBytes` integer, required
      - `maxEvidenceAttachmentBytes` integer, required
    - `monitoringForecast` MonitoringForecast, required
      - `generatedAt` string, date-time, required
      - `periodEnd` string, date-time, required
      - `dailyScreenings` number, required
      - `projectedRemainingScreenings` integer, required
      - `effectiveLimit` integer, required
      - `used` integer, required
      - `reserved` integer, required
      - `remaining` integer, required
      - `projectedExhaustionAt` string, date-time, nullable, required
    - `forecastUnavailable` string, nullable, required

## Other responses

- `400`: **invalid_request** — Correct the request fields, resource identifiers, JSON body or query parameters before retrying.
- `401`: **authentication_required** — Send Authorization: Bearer with a valid API key. An omitted header can produce authentication_required; invalid supplied credentials produce invalid_api_key. **invalid_api_key** — Use an active key for the intended environment.
- `402`: **subscription_required** — Use the synthetic sandbox or arrange an active production subscription before retrying.
- `403`: **permission_denied** — Ask an organization owner to grant the required role or API-key scope. **insufficient_scope** — Use a key with the scope stated in this operation.
- `405`: **method_not_allowed** — Use a method in the Allow response header. OPTIONS lists supported methods; HEAD follows GET authorization and returns no body.
- `413`: **response_too_large** — Reduce the requested page size or use the documented segmented case archive. No evidence is silently truncated.
- `429`: **rate_limited** — Wait for the request window to reset and retry with backoff.
- `500`: **internal_error** — Retry with backoff. For writes reuse the same idempotency key and identical input; include requestId when contacting support.
- `503`: **temporarily_unavailable** — Honor Retry-After when present and retry with bounded backoff. Follow this endpoint’s retry contract; preserve the same key and input for idempotent writes. Contact support with requestId if the failure persists.

---

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