Skip to main content
POST
Nutzungskonfiguration abrufen

Überblick

Rufen Sie die aktuelle Konfiguration des Add-on-Guthabenlimits pro Benutzer:in für Ihre Organisation ab. Limits sind immer pro Benutzer:in. Wenn Sie Konfigurationen auf Team- oder Gruppenebene abfragen, gibt die Antwort das pro Benutzer:in geltende Limit zurück, das auf Benutzer:innen innerhalb dieses Teams oder dieser Gruppe angewendet wurde.

Anfrage

string
erforderlich
Ihr Service Key mit „Billing Read“-Berechtigungen

Bereichskonfiguration (eine Option auswählen)

boolean
Auf true setzen, um das pro Benutzer geltende Limit abzurufen, das auf alle Benutzer im Team angewendet wird
string
Das pro Benutzer geltende Limit für alle Benutzer in einer bestimmten Gruppe abrufen, indem Sie die Gruppen-ID angeben
string
Die Konfiguration für einen bestimmten Benutzer abrufen, indem Sie dessen E-Mail-Adresse angeben
Sie müssen eines von team_level, group_id oder user_email angeben, um den Bereich zu definieren.

Beispielanfrage – Benutzerspezifische Obergrenze für alle Teammitglieder abrufen

Beispielanfrage – Limit pro Benutzer für alle Benutzer in einer Gruppe abrufen

Beispielanfrage – Benutzerkonfiguration abfragen

Antwort

integer
Die konfigurierte Obergrenze für Add-on-Guthaben. Wenn dieses Feld in der Antwort nicht vorhanden ist, ist im angeforderten Geltungsbereich keine Obergrenze konfiguriert.

Beispielantwort – mit konfiguriertem Cap

Beispielantwort – Kein Limit konfiguriert

Fehlerantworten

Häufige Fehlerszenarien:
  • Ungültiger Service Key oder unzureichende Berechtigungen
  • Mehrere Scope-Parameter angegeben
  • Kein Scope-Parameter angegeben
  • Ungültige Gruppen-ID oder Benutzer-E-Mail-Adresse
  • Rate Limit überschritten