Call the routes below when
GET /billing/v1/mode returns bring-your-own-keys. Dedicated deployments always return that mode, including when Langdock manages the model keys. Amounts are US dollars. Cloud workspaces can grant the Billing API scope only where Langdock has enabled it. If the mode is different, these routes return 409.Before You Start
- API key scope:
BILLING_APIon a workspace API key. In the scope picker the scope is labeled Billing API and sits in the Billing group, after User management and before Audit log. Personal keys cannot take this scope. Existing workspace keys do not gain it on their own. - Owner: The key owner is a service account that has not been deleted and has an active Admin membership. Writes run as that service account. If that membership is gone, calls return
403withcodeBILLING_API_ADMIN_REQUIRED. - Names and emails: User objects always include
id, the plan, and limits. They includeemailandnameonly when the same key also hasUSER_MANAGEMENT_API. Filtering users byemailwithout that scope returns403withcodeUSER_MANAGEMENT_API_REQUIRED.
409 with code BILLING_MODE_MISMATCH and the workspace mode in details.mode.
Base URL
Billing mode
standard (Standard) and power_user (Power user). There is no seats route. A path that does not exist in this mode, such as a seats path, returns 404.
Limits
Send and read a limit in one of these shapes. Onlylimited includes amount.
{ "type": "none" }. Agent budgets accept none as well. none removes that extra allowance, or removes the separate agent budget.
A PATCH must include at least one field you can write. Fields you omit stay as they are, including a plan you leave out of monthlyBudgetPerPlan. Unknown fields are rejected.
Lists and spend
Lists default to 50 items. Setlimit from 1 to 250. Pass cursor from the previous page’s nextCursor, and keep the same filters. nextCursor is omitted on the last page. Treat the cursor as opaque.
GET returns spend when the workspace shows per user spend. When that spend is hidden, the spend field is null. User, settings, and agent writes always return null for spend, so a write that already succeeded does not fail while spend is loading. Read the resource again to get spend.
Available endpoints
Errors
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.