Kontingent abfragen

Was dieser Endpunkt zurückgibt

Ein Aufruf zeigt den Monatsstand: enthaltene und verbrauchte Seiten sowie erlaubte Mehrnutzung. Er ist für Ihr Dashboard und Prüfungen vor Stapelaufträgen gedacht.

Liest monatliches Kontingent, Verbrauch und Mehrnutzungsstatus — geeignet für Ihr eigenes Dashboard.

Anfrage

curl https://api.pdfgine.com/api/v1/usage \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

Antwort

{
  "organizationName": "Northwind Trading Ltd.",
  "planCode": "business",
  "monthlyPageQuota": 5000,
  "usedPages": 1284,
  "quotaRemaining": 3716,
  "monthlyPreviewPageAllowance": 250,
  "usedPreviewPages": 32,
  "allowsOverage": true,
  "monthlyOverageCap": 1000,
  "overagePages": 0,
  "meteringBasis": "pdf-equivalent"
}

Feld für Feld

Alle Zähler gelten für den aktuellen Abrechnungsmonat und werden bei dessen Wechsel zurückgesetzt.

Feld	Bedeutung
`monthlyPageQuota`	In diesem Monat im Tarif enthaltene Seiten.
`usedPages`	Bisher in diesem Monat erstellte Seiten.
`quotaRemaining`	monthlyPageQuota minus usedPages zum Zeitpunkt dieser Antwort.
`monthlyPreviewPageAllowance`	Zusätzlich zum Seitenkontingent enthaltene Vorschauseiten; eine Vorschau verbraucht kein Produktionskontingent.
`allowsOverage`	Ob die Erstellung nach Verbrauch des Kontingents weiterläuft. Bei false antwortet die nächste Erstellung mit 402.
`monthlyOverageCap`	Wie weit die Erstellung das Kontingent bei erlaubter Mehrnutzung überschreiten darf.
`meteringBasis`	Bedeutung einer Seite für die Abrechnung. pdf-equivalent zählt docx- oder html-Ausgaben mit derselben Seitenzahl wie das entsprechende PDF.

Personen und Tochterunternehmen

Zwei weitere tarifabhängige Obergrenzen gelten pro Mandant: die Anzahl der Personen im Arbeitsbereich und die Anzahl verwaltbarer Tochterunternehmen.

Tarif	Personen	Tochterunternehmen
Kostenlos	2	0
Go	3	0
Pro	10	5
Max	Unbegrenzt	Unbegrenzt

Eine Einladung über das Platzlimit hinaus wird beim Versand abgelehnt, nicht erst bei der Annahme. So verschwendet niemand Zeit mit einer Einladung, die nie funktionieren könnte.

Häufige Fehler

Rufen Sie diesen Endpunkt nicht nach jeder Erstellung auf. Jede Erstellung liefert bereits X-PDFgine-Quota-Remaining mit demselben Wert, ohne zusätzlichen Aufruf.
Vorschau und Produktion werden getrennt gezählt. Eine Vorschau, die usedPages nicht verändert, ist nicht fehlgeschlagen; sie hat usedPreviewPages verändert.
allowsOverage false bei verbrauchtem Kontingent bedeutet 402 beim nächsten Erstellen, keine langsamere Warteschlange. Beobachten Sie quotaRemaining statt auf den Fehler zu warten.
Kontingent und Ratenlimit sind unterschiedliche Grenzen. Unabhängig vom Restkontingent darf ein Schlüssel 120 Aufrufe je 60 Sekunden ausführen. Darüber folgt 429 mit Retry-After.
Die Zähler folgen dem Abrechnungsmonat, nicht dem Kalendermonat. Bei einem am 12. gekauften Tarif beginnt der neue Monat am 12.