NUTZUNG & KONTINGENT

Eagle Doc bietet einem Business zwei sich ergänzende Sichten auf seinen Verbrauch: den aggregierten Gesamtwert über alle Kunden hinweg und eine Aufschlüsselung pro Kunde. Beide greifen auf dieselben zugrunde liegenden Zähler zu — sie unterscheiden sich nur darin, wie die Nutzung gruppiert wird und welchen Zugang Sie verwenden.

Aggregierte Business-Nutzung

Die bestehenden Usage-Endpunkte funktionieren mit einem Business-Schlüssel unverändert. Authentifizieren Sie sich mit Ihrem APIB-…-Schlüssel im api-key-Header, und Sie erhalten die kombinierten Zähler des Business — die Seiten jedes Kunden in einem Kontingent summiert.

Den aktuellen Abrechnungsmonat mit einem Business-Schlüssel abrufen:

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 liefert vergangene Kontingent-Zeiträume, und GET /api/usage/v1/logs liefert ein Protokoll pro Anfrage. Mit einem Business-Schlüssel aufgerufen, sind beide über alle Kunden hinweg aggregiert.

Diese Endpunkte teilen exakt die Feldstrukturen der persönlichen Usage-API. Alle Felder finden Sie in der vollständigen Referenz zu Nutzung & Kontingent.

Aufschlüsselung pro Kunde

Um die Nutzung nach Kunde aufzuschlüsseln, rufen Sie die Business-Management-API auf. Sie liefert eine Zeile pro Kunde (Sub-Business), sodass Sie pro Kunde abrechnen, auswerten oder abgleichen können, während alles weiterhin auf das eine Abonnement aggregiert wird.

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.

Die Zeile, deren subBusinessId ein leerer String ist, entspricht der eigenen Nutzung des Haupt-Business (Dokumente, die ohne Kunden-Tag verarbeitet wurden). Jede weitere Zeile ist einer Ihrer Kunden.

Die Business-Management-API stellt außerdem GET /api/business/{businessId}/usage/current, …/logs und …/monthly bereit — dieselben Strukturen wie die persönliche Usage-API, jedoch auf das gesamte Business bezogen. Der Logs-Endpunkt akzeptiert die Filter ?subBusinessId=, &start=, &end=, &page= und &size=, um einen einzelnen Kunden oder Zeitraum genauer zu betrachten.

Im Dashboard

Sie bevorzugen eine visuelle Sicht? Öffnen Sie Business → Nutzung im Dashboard. Es zeigt dieselben Zahlen wie die API:

• Eine Kontingent-Karte mit dem vertraglichen Kontingent des Business und den in diesem Monat genutzten Seiten.
• Eine Aufschlüsselung pro Kunde mit einer Zeitraum-Auswahl, um zwischen dem aktuellen Monat und vergangenen Monaten zu wechseln.
• Eine Logs-Tabelle mit einem Kundenfilter und einer Spalte „Von", die anzeigt, wer die jeweilige Anfrage gestellt hat — ein Mitgliedsname oder „API-Schlüssel".

Support