GEgenpage
Account

Get the credit balance for a workspace.

Changed on

Enrichment and AI generation spend credits, so an integration can check what is left before starting work that would fail part-way through.

Credits are pooled across an account: remaining is what the whole pool has left, while workspace_used and workspace_limit describe this one workspace's share of it. A null workspace_limit means uncapped — the workspace can draw on the whole pool.

plan is the raw plan identifier the pool is billed on, so it names the rung as well as the tier (pro_500, scale_5000, ...). Match on its prefix rather than the whole string: grandfathered accounts still report older identifiers such as scale or ultimate.

get/api/external/v1/account/credits

Request

Query parameters

workspace_idinteger required

The workspace to report on.

Example:55

Response

planstring
remaininginteger
workspace_usedinteger
workspace_limitstring
renews_atstring

Example response

{
  "plan": "scale_5000",
  "remaining": 4200,
  "workspace_used": 800,
  "workspace_limit": null,
  "renews_at": "2026-09-01 00:00:00"
}

Changes