Account

Retrieve account usage for the current period

Retrieve the API usage of your account for the CURRENT period: total requests, total documents and a per-tax-ID breakdown.

The subject is the account, so the answer is the same whichever tax ID is effective; the period is resolved server-side.
Distinct from automation run usage, which is per company.
An account identifier that is not yours returns 404 account_not_found.

get/accounts/{account}/usage

Request

Base URL: https://api.factuarea.com/v1
URL: https://api.factuarea.com/v1/accounts/{account}/usage
Auth: one of:
- HTTP bearer
- API key in header X-API-Key

Path parameters

accountstring uuid required

Public identifier (UUID v7) of your account. Get it from GET /v1/me (data.account.id).

Headers

Factuarea-Versionstring date

Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

Example response

{
  "data": {
    "period": {
      "start": "2026-09-01",
      "end": "2026-09-30"
    },
    "requests_count": 18432,
    "documents_count": 512,
    "companies": [
      {
        "requests_count": 2304,
        "documents_count": 64
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.