getMonthlyUsage

Get monthly usage for your organization

GET/api/usage

Returns how many pages and operations your organization has successfully processed in a given month. Use it to surface consumption in your own admin UI, build usage alerts before hitting your plan's quota, or reconcile invoices.

The organization is identified by the API key in the request — there is no organizationId parameter and you cannot query other organizations.

Behavior:

When year and month are omitted, the endpoint returns counters for the current month.
When the organization has no recorded usage for the requested month (e.g. the month is in the future, or the organization didn't process anything), both counters return 0 — this is not an error.
This endpoint is not subject to quota enforcement. Calling it does not count toward your usage and is never blocked by 429/402.

What successful_conversions counts: any operation that completed successfully — both document conversions and document identifications. The name is kept singular for backwards compatibility.

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Bearer token for API authentication

In: header

Query Parameters

year?integer

Year (must be sent together with month). Defaults to the current year.

Range2020 <= value <= 2100

month?integer

Month 1–12 (must be sent together with year). Defaults to the current month.

Range1 <= value <= 12

Response Body

`application/json`

curl -X GET "https://app.docutray.com/api/usage"

{
  "year": 2026,
  "month": 4,
  "successful_pages": 1234,
  "successful_conversions": 89
}

{
  "error": "Invalid month. Must be an integer between 1 and 12."
}

{
  "error": "Unauthorized"
}

getMonthlyUsage