Skip to main content
GET
Get Balance

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspace
string
required

Slug of the workspace the request acts in

Maximum string length: 120
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Response

BalanceResponse · object | null

Successful Response

amount
string | null
required
currency
string
required
exhausted
boolean
required
viewer_is_payer
boolean
required