Zum Hauptinhalt springen
GET
Abrechnungsstatus abrufen
Gibt den aktuellen Abrechnungsstatus Ihres Mandanten zurück. Verwenden Sie diesen Endpunkt in Ihrer Integration, um Zahlungsprobleme frühzeitig zu erkennen und Ihren Benutzern Aufforderungen anzuzeigen, bevor der Zugriff eingeschränkt wird. Wenn alle Zahlungen aktuell sind, ist feature_mode NORMAL und grace_until ist null. Wenn eine Zahlung fehlschlägt, tritt das Konto in einen gestuften Zugriffs-Workflow ein – Herabgestuft, Eingeschränkt, dann Gesperrt – mit einer Schonfrist in jeder Phase.

Antwort

string
Der Status des Abrechnungskontos: ACTIVE, PAST_DUE, UNPAID oder SUSPENDED.
string
Die aktuelle Funktionsfähigkeit:
  • NORMAL – alle Funktionen verfügbar
  • DEGRADED – Zahlung fehlgeschlagen; alle Funktionen funktionieren während der Schonfrist weiterhin
  • RESTRICTED – Schonfrist läuft ab; Schreibvorgänge (Prägen, Schlüsselerstellung) sind deaktiviert
  • SUSPENDED – Schonfrist abgelaufen; der gesamte API-Zugriff ist deaktiviert, bis die Zahlung erfolgt ist
string | null
ISO 8601 Zeitstempel, wann die aktuelle Nachfrist endet, oder null, wenn das Konto in gutem Zustand ist.
string | null
Eine menschenlesbare Nachricht, die die erforderliche Aktion beschreibt, oder null, wenn keine Aktion erforderlich ist.

Wann dieser Endpunkt verwendet werden sollte

Verwenden Sie GET /v1/billing/status, um:
  • Zahlungsaufforderungen anzeigen – überprüfen Sie feature_mode beim Start der App oder beim Login und zeigen Sie ein Banner an, wenn der Wert nicht NORMAL ist.
  • Schreiboperationen schützen – vor dem Prägen oder Erstellen von Schlüsseln überprüfen, ob feature_mode nicht RESTRICTED oder SUSPENDED ist.
  • Kulanzfristen verfolgen – lesen Sie grace_until, um Ihren Benutzern genau zu zeigen, wie lange sie Zeit haben, ein Zahlungsproblem zu lösen.

Kulanzzeitraum

Die Standard-Kulanzfristen für den Standard-Vertragsmodus sind: Unternehmensverträge verlängern jedes Fenster um 14 zusätzliche Tage. Regierungsverträge verwenden eine feste 90-tägige Nachfrist ohne automatische Aussetzung. Details finden Sie unter Vertragsmodi.
Eine vollständige Aufschlüsselung des gestuften Zugriffs-Workflows finden Sie unter Zahlungsausfälle und Kulanzfristen.

Autorisierungen

X-API-Key
string
header
erforderlich

API-Schlüssel für die Maschine-zu-Maschine-Authentifizierung

Antwort

Abrechnungsstatus

plan
string
status
string
trial_ends_at
string | null