---
title: "get_usage"
method: GET
path: "/v1/usage"
---

# get_usage

`GET /v1/usage`

## Request

- Base URL: `https://app.agentlinkops.com`
- URL: `https://app.agentlinkops.com/v1/usage`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Remaining read arguments go in query parameters.

## Query parameters

- `period` string: Billing month in UTC, formatted YYYY-MM; defaults to the current month.

## Headers

- `X-Workspace-ID` string

## Response `200`

Remaining read arguments go in query parameters.

- object
  - `workspace_id` string, required: Workspace that owns this record.
  - `period` string, required
  - `plan` string, required
  - `subscription_status` string, required
  - `check_reservations` object, required
    - `reserved` number, required
    - `consumed` number, required
    - `released` number, required
    - `note` string, required
  - `monthly_check_limit` number, nullable, required
  - `check_budget` object, required
    - `period` string, required
    - `limit` number, nullable, required
    - `reserved` number, required
    - `consumed` number, required
    - `remaining` number, nullable, required: Check units still available after consumed and reserved units; null if the limit is unknown.
    - `exhausted` boolean, nullable, required
    - `resets_at` string, required
    - `enforced_by` string, required
    - `plan_allowance_enforced` boolean, required
  - `active_watch_limit` number, nullable, required
  - `units` object, required
  - `chargeable_microusd` number, required
  - `pricing_mode` 'estimate_only', required
  - `at_allowance` object, required
    - `at_allowance` string, required
    - `enforced_limit` string, required
    - `note` string, required
  - `checkout` object, required
    - `available` boolean, required
    - `reason` string, nullable, required: Recorded explanation; null when no explanation applies.
  - `collected` false, required

## Other responses

- `429`: Request-rate or usage refusal. Inspect error.code and recovery details before retrying.
- `default`: Error envelope. Non-configuration 5xx messages are masked and details omitted; allowlisted configuration errors retain static operator recovery.

---

[API](https://skmtc.dev/agentlinkops/apis/agentlinkops-http-api.md) · [All operations](https://skmtc.dev/agentlinkops/apis/agentlinkops-http-api/llms.txt) · [OpenAPI document](https://skmtc.dev/agentlinkops/apis/agentlinkops-http-api/revisions/1bf30c2912b2?raw)