Zum Hauptinhalt springen
PUT
Set user extra usage budget
Liste aktive menschliche Mitglieder, ändere einen Plan und setze das Extra-Usage-Budget über dem enthaltenen Kontingent. Beträge sind US-Dollar. Die Aufrufe laufen über den BILLING_API Scope des Workspace-API-Schlüssels. Schreibzugriffe laufen als der Service Account, dem der Schlüssel gehört. Diese API lädt niemanden ein und deaktiviert niemanden. Dafür nutzt du die User Management API.

Basis-URL

Dedicated DeploymentsErsetze api.langdock.com durch <your-deployment-url>/api/public in allen Anfragen.

Voraussetzungen

  • API-Schlüssel mit dem Scope BILLING_API
  • Der Besitzer ist ein Service Account, der nicht gelöscht ist und eine aktive Admin-Mitgliedschaft hat
  • USER_MANAGEMENT_API am selben Schlüssel, wenn du email, name oder einen E-Mail-Filter brauchst

Extra-Usage-Budget setzen

PUT /users/{userId}/extra-usage-budget nimmt das Budget direkt entgegen. Es gibt kein Hüllenfeld.
{ "type": "none" } entfernt das Extra-Kontingent. { "type": "unlimited" } entfernt die Zahlenobergrenze. Ein begrenzter Betrag darf null sein. War das effektive Budget begrenzt und ist das neue effektive Budget höher oder unbegrenzt, wird die offene Nutzungslimit-Anfrage des Mitglieds geschlossen. Dasselbe oder ein niedrigeres Budget lässt die Anfrage offen. Ohne usageRequestId wird das Budget gespeichert, auch wenn das Schließen der Anfrage fehlschlägt. Übergib usageRequestId in der Query, um genau diese Anfrage im selben Schreibzugriff zu beantworten. Das Budget wird nur gespeichert, wenn die Anfrage zu diesem Mitglied gehört, noch offen ist und das effektive Budget wie oben steigt. Sonst wird nichts geschrieben. Fehlt die Anfrage oder gehört sie nicht zu diesem Mitglied, kommt 404 mit code NOT_FOUND. Ist sie nicht mehr offen, kommt 409 mit code USAGE_REQUEST_NOT_PENDING. Steigt das Kontingent nicht, kommt 409 mit code USAGE_REQUEST_NOT_ANSWERED. Die Anfrage bleibt offen. Die Antwort ist das Mitgliedsobjekt mit extraUsagePeriodSpend auf null.
Langdock blockiert bewusst Browser-basierte Anfragen, um deinen API-Schlüssel zu schützen und die Sicherheit deiner Anwendungen zu gewährleisten. Weitere Informationen findest du in unserem Guide zu Best Practices für API-Schlüssel.

Autorisierungen

Authorization
string
header
erforderlich

API key as Bearer token. Format "Bearer YOUR_API_KEY"

Pfadparameter

userId
string<uuid>
erforderlich

Abfrageparameter

usageRequestId
string<uuid>

Optional pending usage request this write answers. The write is rejected with 404 unless the request belongs to this member, 409 USAGE_REQUEST_NOT_PENDING if it is no longer pending, or 409 USAGE_REQUEST_NOT_ANSWERED if the write does not increase the member's allowance (an unchanged or lower limit, or a plan the member already has); nothing is written in those cases. A real increase or upgrade resolves the member's pending request with or without this parameter.

Body

application/json
type
enum<string>
erforderlich
Verfügbare Optionen:
limited
amount
number
erforderlich
Erforderlicher Bereich: x >= 0

Antwort

Updated resource. Spending is null; GET retrieves spending.

USD. The highest plan/group monthly budget configures weekly and session allowances. Extra usage can start when those included allowances are exhausted. Spend is null when private and always null in mutation responses.

id
string<uuid>
erforderlich
plan
enum<string>
erforderlich
Verfügbare Optionen:
standard,
power_user
monthlyBudget
object
erforderlich
extraUsageBudget
object
erforderlich
extraUsagePeriodSpend
number | null
erforderlich
Erforderlicher Bereich: x >= 0
email
string<email>

Present only when the key also has the USER_MANAGEMENT_API scope.

name
string | null

Present only when the key also has the USER_MANAGEMENT_API scope.