Zum Hauptinhalt springen
POST
Nutzungskonfiguration abrufen

Überblick

Rufen Sie die aktuelle Konfiguration der Obergrenze für Zusatzguthaben pro Nutzer für Ihre Organisation ab. Obergrenzen gelten immer pro Nutzer. Wenn Sie mit dem Geltungsbereich Team oder Gruppe abfragen, enthält die Antwort die pro Nutzer geltende Obergrenze, die auf die Nutzer in diesem Team oder dieser Gruppe angewendet wird.

Anfrage

service_key
string
erforderlich
Ihr Service-Schlüssel mit „Billing Read“-Berechtigungen

Konfiguration des Geltungsbereichs (eine Option auswählen)

team_level
boolean
Auf true setzen, um die für alle Nutzer im Team geltende Obergrenze pro Nutzer abzurufen
group_id
string
Rufen Sie die für alle Nutzer in einer bestimmten Gruppe geltende Obergrenze pro Nutzer ab, indem Sie die Gruppen-ID angeben
user_email
string
Rufen Sie die Konfiguration für einen bestimmten Nutzer ab, indem Sie seine E-Mail-Adresse angeben
Sie müssen team_level, group_id oder user_email angeben, um den Geltungsbereich festzulegen.

Beispielanfrage – Obergrenze pro Nutzer für alle Nutzer im Team abrufen

Beispielanfrage - Die Pro-Nutzer-Obergrenze für alle Nutzer einer Gruppe abrufen

Beispielanfrage - Nutzerkonfiguration abrufen

Antwort

addOnCreditCap
integer
Der konfigurierte Wert für die Obergrenze des Zusatzguthabens. Wenn dieses Feld in der Antwort nicht vorhanden ist, ist auf der angeforderten Geltungsbereichsebene keine Obergrenze konfiguriert.

Beispielantwort – Mit konfigurierter Obergrenze

Beispielantwort – Keine Obergrenze konfiguriert

Fehlerantworten

Häufige Fehlerfälle:
  • Ungültiger Service-Schlüssel oder unzureichende Berechtigungen
  • Mehrere Parameter für den Geltungsbereich angegeben
  • Kein Parameter für den Geltungsbereich angegeben
  • Ungültige Gruppen-ID oder Nutzer-E-Mail
  • Rate-Limit überschritten