Zum Hauptinhalt springen
PUT
Set the group monthly budget
Lies Gruppen und setze ein Monatsbudget für jedes Mitglied einer Gruppe. Das Budget ist kein gemeinsamer Topf. 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 fügt keine Gruppenmitglieder hinzu und entfernt keine.

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

Monatsbudget setzen

PUT /groups/{groupId}/monthly-budget nimmt das Budget direkt entgegen.
{ "type": "unlimited" } entfernt die Zahlenobergrenze. Ein begrenzter Betrag darf null sein. none ist hier nicht erlaubt. Für jedes Mitglied ist das enthaltene Monatsbudget der höhere Wert aus Planbudget und diesem Gruppenbudget. Ein unbegrenztes Gruppenbudget hebt das Workspace-Limit nicht auf. Unter Billing-Nutzer steht, wie die effektive Quelle gewählt wird. Die Antwort ist das Gruppenobjekt.
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

groupId
string<uuid>
erforderlich

Body

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

Antwort

Successful response.

USD per-member monthly budget; the highest plan/group value applies. Does not override the workspace cap.

id
string<uuid>
erforderlich
name
string
erforderlich
scimManaged
boolean
erforderlich
memberCount
integer
erforderlich
Erforderlicher Bereich: x >= 0
monthlyBudget
object
erforderlich