Account
Two read-only endpoints for the API key's owning account: a snapshot of plan and available credits (with the two numbers an SDK needs to throttle itself), and a paginated ledger of credit consumption for self-service reconciliation.
Get account
Returns your account's effective plan and credits — if your account is a member of a Team, this already reflects the team owner's plan/credit pool, not your own individual membership_plan.
Parameters
None — the account is determined entirely by the API key in the Authorization header.
max_batch_size and upload_concurrency are provided so a client SDK can self-throttle its own upload loop instead of discovering these limits by hitting invalid_parameter/ rate_limit_exceeded errors first.
Possible errors
missing_api_key/invalid_api_key/plan_required— see Error Handling.
Get account usage
A paginated, newest-first ledger of every credit-affecting event on your account — extraction deductions, bbox-annotation deductions, and refunds. Built for reconciling "how many credits did this cost me," not for driving a UI (compare /profile/usage_history's pre-formatted display strings, which this endpoint does not return — you get structured, signed amount values instead).
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
limit | query, optional | integer | 1–200. Default 50. |
batch_name | query, optional | string | Restrict the ledger to entries for one batch — "how many credits did batch X cost me." |
page_token | query, optional | string | Opaque cursor from a previous response's next_page_token. This endpoint paginates newest-first (unlike other v1 list endpoints, which paginate oldest-first) — the token is still opaque and round-trips the same way, only the underlying order differs. See Pagination. |
amount is signed: negative for spends (extraction/bbox deductions), positive for credits back (refunds/cancellation refunds) — so summing a page's amount values gives you the net change over that page. document_id is the same ID space as Documents' document_id (the internal ledger calls it task_id; this endpoint renames it for consistency with the rest of v1).
Possible errors
missing_api_key/invalid_api_key/plan_required— see Error Handling.invalid_parameter— badlimitorpage_token.