USAGE & QUOTA

Eagle Doc gives a business two complementary views of its consumption: the rolled-up total across all clients, and a per-client breakdown. Both read from the same underlying counters — they differ only in how usage is grouped and which credential you use.

Rolled-up business usage

The existing usage endpoints work unchanged with a business key. Authenticate with your APIB-… key in the api-key header and you receive the business’s combined counters — every client’s pages summed into one quota.

Read the current billing month with a business key:

curl --location 'https://de.eagle-doc.com/api/usage/v1/current' \
  --header 'api-key: APIB-your-business-key'

import requests

resp = requests.get(
    "https://de.eagle-doc.com/api/usage/v1/current",
    headers={"api-key": "APIB-your-business-key"},
)
print(resp.json())

const resp = await fetch("https://de.eagle-doc.com/api/usage/v1/current", {
  headers: { "api-key": "APIB-your-business-key" },
});
console.log(await resp.json());

GET

/api/usage/v1/current

Parameters

Name	Description
api-key (header)	A business API key (APIB-…). The response is rolled up across all of the business’s clients.

Responses

Code	Description
200	OK — the business’s combined usage for the current billing month. Field Name Description currentMonth The billing month in YYYY-MM format. contractQuota Pages included by the business contract. quotaUsed Pages processed so far this month across all clients. overUsageAllowed Whether usage may exceed contractQuota. hardLimit A ceiling above which no more pages are processed (may be null). overUsage Pages beyond the contract quota (quotaUsed - contractQuota). pricePerPageOverUsage Agreed price per over-usage page. overUsageCost overUsage × pricePerPageOverUsage. { "currentMonth": "2026-07", "contractQuota": 1000, "quotaUsed": 143, "overUsageAllowed": false, "hardLimit": 2000, "overUsage": 0, "pricePerPageOverUsage": 0.0, "overUsageCost": 0.0 }
403	BadCredentialException — the API key is missing or invalid.
500	InternalServerErrorException — something went wrong for an unknown reason.

GET /api/usage/v1/monthly returns past quota periods, and GET /api/usage/v1/logs returns a per-request log. Called with a business key, both are rolled up across all clients.

These endpoints share the exact field shapes of the personal usage API. See the full usage & quota reference for every field.

Per-client breakdown

To split usage by client, call the business management API. It returns one row per client (sub-business), so you can bill, report or reconcile per client while everything still rolls up to the one subscription.

GET

/api/business/{businessId}/usage/breakdown

Parameters

Name	Description
businessId (path)	The id of your business.
period (query)	current for the ongoing billing month, or a past month as YYYY-MM.
api-key (header)	A real-user token: a personal API-… key (or dashboard session) with role MEMBER or higher. APIB-… keys are rejected.

Responses

Code	Description
200	OK — an array of per-client usage rows for the requested period. Field Name Description subBusinessId The client’s id. An empty string marks the main business’s own usage. subBusinessName The client’s display name. Deleted clients appear as (deleted sub-business). externalClientRef Your own client reference (the x-sub-business-ref you sent), if any. pages Pages processed for this client (may be fractional). pageCredits Billed page credits for this client. requests Number of requests made for this client. [ { "subBusinessId": "", "subBusinessName": "Acme GmbH", "externalClientRef": "", "pages": 40.0, "pageCredits": 52, "requests": 12 }, { "subBusinessId": "66cc...", "subBusinessName": "Client A", "externalClientRef": "CRM-1001", "pages": 103.0, "pageCredits": 130, "requests": 31 } ]
403	A business APIB-… key was used, or the token lacks the MEMBER role. The error body follows the standard shape (httpCode, httpCodeName, messageCode, message, messageDetails, data).
500	InternalServerErrorException — something went wrong for an unknown reason.

The row whose subBusinessId is an empty string is the main business’s own usage (documents processed without a client tag). Every other row is one of your clients.

The business management API also exposes GET /api/business/{businessId}/usage/current, …/logs and …/monthly — the same shapes as the personal usage API, scoped to the whole business. The logs endpoint accepts ?subBusinessId=, &start=, &end=, &page= and &size= filters to drill into a single client or date range.

In the dashboard

Prefer a visual view? Open Business → Usage in the dashboard. It shows the same numbers as the API:

• A quota card with the business’s contract allowance and pages used this month.
• A per-client breakdown with a period selector to switch between the current month and past months.
• A logs table with a client filter and a “By” column showing who made each request — a member name or “API key”.

Support