Skip to main content
GET
Get organization account balance
This endpoint requires an Admin Key with the billing:read scope.

Authorizations

Authorization
string
header
required

Send the Admin API secret as a Bearer token in the Authorization header (Bearer sk-admin-***). Create Admin Keys under Console → Organization → Admin API Keys.

Response

Account balance and cumulative amounts (milli-cent).

available_balance
integer<int64>
required

Available balance, recharge + voucher combined (milli-cent).

total_consume
integer<uint64>
required

Total consumption, recharge + voucher combined (milli-cent).

total_recharge_amount
integer<uint64>
required

Total amount ever recharged (milli-cent).

total_voucher_amount
integer<uint64>
required

Total vouchers ever issued (milli-cent).