Get balance - Lyceum Documentation

Get balance

curl --request GET \
  --url https://api.example.com/api/v2/external/orgs/{slug}/balance

{
  "org_id": "<string>",
  "balance": "<string>",
  "account_suspended": true
}

GET

api

external

orgs

{slug}

balance

Get balance

curl --request GET \
  --url https://api.example.com/api/v2/external/orgs/{slug}/balance

{
  "org_id": "<string>",
  "balance": "<string>",
  "account_suspended": true
}

slug

string

required

Successful Response

Org billing balance (from Croesus).

org_id

string

required

balance

string

required

Decimal string. Do not cast to float.

account_suspended

boolean

required