---
title: "Get account usage"
method: GET
path: "/v1/accounts/{accountId}/usage"
tags: ["Accounts"]
---

# Get account usage

`GET /v1/accounts/{accountId}/usage`

## Request

- Base URL: `https://api.assinafy.com.br`
- URL: `https://api.assinafy.com.br/v1/accounts/{accountId}/usage`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`
- TypeScript: <https://skmtc.dev/assinafy/apis/assinafy-api-reference/docs/v1/accounts/:accountId/usage/get.ts> (a function with typed inputs; its response is checked against the schema)

The workspace's plan and what is left of it, for a plan and credit meter. Nothing about prices or payments: those stay in **Get current subscription**. Not available to third-party OAuth applications (`403`), whatever their scopes: this is billing data. Assinafy's own apps can read it with the `account:read` scope.

[Copy as Markdown](https://api.assinafy.com.br/v1/docs/markdown?method=get&path=%2Fv1%2Faccounts%2F%7BaccountId%7D%2Fusage) [Open in ChatGPT](https://chatgpt.com/?q=Read%20the%20API%20documentation%20at%20https%3A%2F%2Fapi.assinafy.com.br%2Fv1%2Fdocs%2Fmarkdown%3Fmethod%3Dget%26path%3D%252Fv1%252Faccounts%252F%257BaccountId%257D%252Fusage%20and%20help%20me%20integrate%20this%20endpoint.) [Open in Claude](https://claude.ai/new?q=Read%20the%20API%20documentation%20at%20https%3A%2F%2Fapi.assinafy.com.br%2Fv1%2Fdocs%2Fmarkdown%3Fmethod%3Dget%26path%3D%252Fv1%252Faccounts%252F%257BaccountId%257D%252Fusage%20and%20help%20me%20integrate%20this%20endpoint.)

## Path parameters

- `accountId` string, required

## Response `200`

The usage

- object: Standard success wrapper. Operations add their own `data`.
  - `status` integer: HTTP status code, mirrored in the body.
  - `message` string: Human-readable message; empty on success.
  - `data` AccountUsage: The workspace's plan and what is left of it.
    - `plan` string, nullable: The plan's name. `null` when the subscription has no plan or its plan was retired.
    - `documents_renewal_date` string, date, nullable: When the document allowance next renews. On a custom contract, the next boundary of the contract's billing day. `null` while the subscription awaits its first payment, or on a contract with no billing day.
    - `balances` object: Document and credit balances, as in **Get current subscription**.
      - `documents` Balance: A document or credit balance for the current billing cycle.
        - `balance` number, nullable: Remaining quantity; null for unlimited.
        - `limit` number, nullable: Allowance per cycle/pool; null when not cycle-limited or unlimited.
        - `spent` number: Quantity consumed in the current cycle.
      - `credits` Balance: A document or credit balance for the current billing cycle.
        - `balance` number, nullable: Remaining quantity; null for unlimited.
        - `limit` number, nullable: Allowance per cycle/pool; null when not cycle-limited or unlimited.
        - `spent` number: Quantity consumed in the current cycle.

## Other responses

- `401`: Missing or invalid credentials.
- `403`: Authenticated but not allowed to perform this action.
- `404`: The requested resource does not exist.
- `500`: Unexpected server error.

## Changes

- **2026-11-04** `5fcad067d962`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/assinafy/apis/assinafy-api-reference/changes/v1/accounts/:accountId/usage/get.md)

---

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