GET
/
v3
/
billing
/
balance
Get Balance
curl --request GET \
  --url http://127.0.0.1:3333/v3/billing/balance \
  --header 'Authorization: Bearer <token>'
{
  "credits": 123,
  "currency": "<string>",
  "wallet": {
    "total": 123,
    "recurring": 123,
    "purchased": 123
  },
  "addons": {
    "seats": {
      "total": 123,
      "used": 123
    },
    "storage": {
      "total": 123,
      "used": 123
    }
  },
  "workspaceId": "<string>",
  "billingHold": true,
  "billingHoldReason": "<string>",
  "billingHoldAt": "<string>",
  "creditDebt": 123
}

Authorizations

Authorization
string
header
required

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

Query Parameters

workspaceId
string
required

Response

Default Response

credits
number
required
currency
string
required
wallet
object
required
addons
object
required
workspaceId
string
required
billingHold
boolean
billingHoldReason
string | null
billingHoldAt
string | null
creditDebt
number