API reference
Retrieve usage
Retrieve current or historical processed-page usage for the account. Pages are counted when processing finishes. Documents still being processed are not included.
On this page
GET/v1/usage
Query parameters
accounting_entity_idstringoptional
Optional opaque entity namespace to attribute finalized processed pages to one accounting entity. This filters the entity breakdown. Account totals stay the same.
periods_agointegeroptional
Optional closed historical billing period to report, counted backwards from the current entitlement period: 1 is the most recently closed retained period. Omit it for the current period.
Responses
200- the usage report for the requested period.400- invalid query combination, described through the typed error envelope.404- the requested historical period is outside the retained window.
Usage shape
The report carries the period ( type, start, end), the plan (trial or subscription tier), included_pages, used_pages, remaining_pages, and overage_pages. Paid Starter/Pro plans continue into overages rather than hard-stopping at included usage.
When accounting_entity_id filters the report, an attribution section breaks finalized pages down per entity; account-level totals stay authoritative for billing.