Skip to main content
GET
Read the workspace's credit balance

Authorizations

Authorization
string
header
required

A workspace API key, sent as Authorization: Bearer sempera_sk_... Each operation names the one scope it needs. Scopes, key kinds and roles are in the Authentication guide.

Response

The balance, what is on hold, and what each action costs.

object
any
required
workspace_id
string
required
balance
integer
required

Credits available now.

Required range: x >= 0
held
integer
required

Credits held for work in progress, already out of balance.

Required range: x >= 0
spent_total
integer
required
Required range: x >= 0
costs
object[]
required
packs
object[]
required
free_grant
integer
expires
any

Credits never expire.

pays_for
string
does_not_pay_for
string
also
string
debt
integer

Credits owed after a refund or dispute. Blocks building and packs.

Required range: x >= 0
can_buy
boolean
buy_note
string | null
test_packs_add_credits
boolean