Read this workspace's spend against its budget caps
What this workspace has spent, this month and last, against the caps it has configured, broken down per model.
/v1/workspace/billingAdmin- Operation id
- billing_snapshot
- Access
- An editor or a viewer is refused.
/v1/workspace/billingWhat this workspace has spent, this month and last, against the caps it has configured, broken down per model.
This is measured usage, not an invoice. It reports what the workspace used and what limits it set for itself. It states no price and produces no bill.
The caps are the ones set on the workspace settings. A cap of null means none is configured, which is not the same as a cap of zero.
Figures cover calendar months in UTC, so "this month" restarts on the first.
Tenancy: the request is scoped to one workspace, and the credential presented is what selects it. A caller with no membership in that workspace is refused with 404, which is indistinguishable from a workspace that does not exist.
Authorisation: admin or owner. An editor or viewer receives 403 insufficient_role.
Access: Authorization: Bearer carrying either a realm access token or an API key. A key must hold the workspace-admin:write scope, and the workspace role of the person who owns it must meet the floor above.
A realm-issued access token, presented as Authorization: Bearer <token>. It acts as the person who signed in, and every operation resolves their workspace role live from the membership record.
In: header
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/workspace/billing"{}