Skip to main content
PUT
Set the group monthly budget
Read groups and set a monthly budget for each member of a group. The budget is not a shared pool. Amounts are US dollars. The calls use the workspace API key’s BILLING_API scope. Writes run as the key’s service account owner. This API does not add or remove group members.

Base URL

Dedicated deploymentsReplace api.langdock.com with <your-deployment-url>/api/public in all requests.

Prerequisites

  • API key with the BILLING_API scope
  • The key owner is a service account that has not been deleted and has an active Admin membership

Set the monthly budget

PUT /groups/{groupId}/monthly-budget takes the budget directly.
{ "type": "unlimited" } removes the numeric cap. A limited amount may be zero. This value does not accept none. For each member, the included monthly budget is the higher of the plan budget and this group budget. An unlimited group budget does not remove the workspace cap. See Billing Users for how the effective source is chosen. The response is the group object.
Langdock intentionally blocks browser-origin requests to protect your API key and ensure your applications remain secure. For more information, please see our guide on API Key Best Practices.

Authorizations

Authorization
string
header
required

API key as Bearer token. Format "Bearer YOUR_API_KEY"

Path Parameters

groupId
string<uuid>
required

Body

application/json
type
enum<string>
required
Available options:
limited
amount
number
required
Required range: x >= 0

Response

Successful response.

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

id
string<uuid>
required
name
string
required
scimManaged
boolean
required
memberCount
integer
required
Required range: x >= 0
monthlyBudget
object
required