billing

Get credit usage summary

Returns cumulative credit usage for the authenticated user, plus current workspace usage and project/Brain-level usage.

get/api/v1/billing/usage

Request

  • Base URL: https://api.cadencz.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.cadencz.com/api/v1/billing/usage
  • Auth: HTTP bearer

Response

Successful Response

user_idstring required
workspace_idstring required
balanceinteger required
grantedinteger required
usedinteger required
workspace_balanceinteger required
workspace_grantedinteger required
workspace_usedinteger required
cost_usd_microsinteger required
workspace_cost_usd_microsinteger required

Example response

{
  "balance": 348,
  "categories": [
    {
      "balance": -2,
      "cost_usd_micros": 1200,
      "granted": 0,
      "label": "Brain compose",
      "reason": "text_draft",
      "used": 2
    }
  ],
  "cost_usd_micros": 1200,
  "granted": 350,
  "projects": [
    {
      "balance": -2,
      "cost_usd_micros": 1200,
      "granted": 0,
      "name": "Orbit CRM",
      "project_id": "brain_123",
      "project_type": "brain",
      "used": 2,
      "workspace_id": "wks_123"
    }
  ],
  "used": 2,
  "user_id": "CAD1234567890912",
  "workspace_balance": 348,
  "workspace_cost_usd_micros": 1200,
  "workspace_granted": 350,
  "workspace_id": "wks_123",
  "workspace_used": 2
}

Changes

No recorded changes to this operation across all 1 revision of this API.