DocsAPI reference

Overview

The whole billing page in one request.

get/api/billing/overview
Authentication
Bearer token
Retries
Safe to repeat
Body
None
Version
2026-09-03

Plan, balance, forecast, this month's calculation and - for the owner - the five latest payments. The page used to need four requests to draw its first screen; this is one, with one balance read shared by every part of it, and an ETag so a revisit with nothing changed is a 304.

Payments are included only for the owner, for the reason the payments endpoint is owner-only: the balance is everybody's business, the company's card history is not.

Responses#

  • 200OKapplication/json

    any

    5 response headers
    RateLimit-Limit

    Requests permitted in the current window.

    RateLimit-Remaining

    Requests left in the current window. Back off before it reaches 0.

    RateLimit-Reset

    Seconds until the current window resets.

    X-API-Version

    The dated version of the API contract that served this response, e.g. 2026-09-03. Pin against it; it changes only when a response shape changes incompatibly.

    X-Request-ID

    Quote this in a support request to identify the call.

Errors#

Failures use one envelope on every endpoint, described in Retries, versioning and limits. The codes you are most likely to meet here:

  • unauthenticated · 401 — The request carried no API key, or one the API could not verify.
  • forbidden · 403 — The key is valid, but it is not allowed to do this — either the scope is missing or the resource belongs to another workspace.
  • rate_limited · 429 — Too many requests in the current window. The limit is per workspace, and some endpoints add a per-agent limit on top.

More Billing endpoints#

Something unclear or missing? Tell us and we’ll fix it.