Usage

How many credits your organization has consumed, over the last 30 days and since the start of the month.

Get usage

GET/api/v1.1/usage

Credits consumed over the last 30 days and since the start of the month. Extraction costs 1 credit per page, classification 1 per document, segmentation 1 per operation. Counts update as work completes.

Response

last_30_daysobject
total, extraction, classification and segmentation credits.
since_month_startobject
The same breakdown since the 1st, 00:00 UTC.
period_startstring
The 1st of the month, 00:00 UTC.
period_endstring
When the figures were computed.
organizationstring
current_planobject | null
type (SANDBOX, PAY_PER_PAGE, STARTER, PRO, ENTERPRISE), name and included_credits. Null without an active plan.
sandboxobject
Sandbox organizations only: credits_limit, credits_used, credits_remaining and usage_percentage (0 to 100). The limit applies at once.

For a sandbox organization the response also carries sandbox:

"sandbox": {
  "credits_limit": 3500,
  "credits_used": 245,
  "credits_remaining": 3255,
  "usage_percentage": 7.0
}

curl "https://app.holofin.ai/api/v1.1/usage" \
  -H "X-API-Key: $HOLOFIN_API_KEY"

import os

import requests

response = requests.get(
    "https://app.holofin.ai/api/v1.1/usage",
    headers={"X-API-Key": os.environ["HOLOFIN_API_KEY"]},
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://app.holofin.ai/api/v1.1/usage", {
  headers: {
    "X-API-Key": process.env.HOLOFIN_API_KEY,
  },
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

200

{
  "last_30_days": {
    "total": 2534,
    "extraction": 2456,
    "classification": 45,
    "segmentation": 33
  },
  "since_month_start": {
    "total": 948,
    "extraction": 892,
    "classification": 32,
    "segmentation": 24
  },
  "period_start": "2025-10-01T00:00:00+00:00",
  "period_end": "2025-10-15T14:32:45.123456+00:00",
  "organization": "Acme Corp",
  "current_plan": {
    "type": "PRO",
    "name": "Pro",
    "included_credits": 100000
  }
}