---
title: "Usage and billing state"
method: GET
path: "/api/usage"
---

# Usage and billing state

`GET /api/usage`

## Request

- Base URL: `https://bol.ai`
- URL: `https://bol.ai/api/usage`
- Auth: HTTP bearer

Remaining prepaid credits, active subscription (if any) and can_extract. Agents should call this before large batches instead of discovering exhaustion via a 402 mid-batch. A 402 from extract endpoints includes buy_credits_url and checkout_endpoint so a human can top up.

## Response `200`

Usage state

- object
  - `credits` integer
  - `subscription` object, nullable
    - `status` string
    - `plan` 'starter' | 'professional'
    - `current_period_end` string, nullable
  - `can_extract` boolean
  - `buy_credits_url` string

---

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