Account
Balance
Check your Vobiz account balance by currency - available balance, reserved funds, promotional credit, credit limit, and low-balance thresholds.
GET
/
api
/
v1
/
Account
/
{auth_id}
/
balance
/
{currency}
Get balance
curl --request GET \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/balance/{currency} \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/balance/{currency}"
headers = {
"X-Auth-ID": "<api-key>",
"X-Auth-Token": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/balance/{currency}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "aabbccdd-1234-5678-90ab-cdef12345678",
"account_id": "MA_XXXXXXXX",
"currency": "INR",
"balance": 23906.83,
"reserved_funds": 0,
"promotional_balance": 0,
"promotional_reserved_balance": 0,
"available_balance": 23906.83,
"credit_limit": 1000,
"is_postpaid": true,
"credit_limit_type": "soft",
"low_balance_threshold": 50,
"status": "active",
"created_at": "2026-01-19T18:39:15.050543Z",
"updated_at": "2026-05-11T06:59:32.802705Z"
}Get Balance
GET https://api.vobiz.ai/api/v1/Account/{auth_id}/balance/{currency}
Authentication required:
X-Auth-ID- Your account Auth IDX-Auth-Token- Your account Auth TokenContent-Type: application/json
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
auth_id | string | Yes | Your account Auth ID. |
currency | string | Yes | Currency code to query (e.g., INR, USD). Must match a currency the account holds a balance in. |
Response fields
| Field | Type | Description |
|---|---|---|
balance | number | Total ledger balance. |
reserved_funds | number | Funds held against in-progress calls or pending charges. |
promotional_balance | number | Non-withdrawable promotional credit. |
available_balance | number | Spendable amount (balance minus reservations). Check this before purchasing a number. |
credit_limit | number | Postpaid credit line. |
is_postpaid | boolean | Whether the account bills postpaid. |
credit_limit_type | string | soft or hard. A hard limit blocks new calls/purchases once exhausted. |
low_balance_threshold | number | Threshold below which low-balance alerts fire. |
status | string | Balance status (e.g., active). |
Request
cURL
curl --location 'https://api.vobiz.ai/api/v1/Account/YOUR_AUTH_ID/balance/INR' \
--header 'X-Auth-ID: YOUR_AUTH_ID' \
--header 'X-Auth-Token: YOUR_AUTH_TOKEN' \
--header 'Accept: application/json'
Response
JSON Response
{
"id": "aabbccdd-1234-5678-90ab-cdef12345678",
"account_id": "MA_XXXXXXXX",
"currency": "INR",
"balance": 1000.00,
"reserved_funds": 0,
"promotional_balance": 0,
"promotional_reserved_balance": 0,
"available_balance": 1000.00,
"credit_limit": 1000,
"is_postpaid": true,
"credit_limit_type": "soft",
"low_balance_threshold": 50,
"status": "active",
"created_at": "2026-01-19T18:39:15.050543Z",
"updated_at": "2026-05-11T06:59:32.802705Z"
}
Related
Transactions
Retrieve the credit and debit ledger behind the balance, with per-day totals.
Channel Pricing Preview
Preview what a channel subscription will cost before it debits the balance.
Authorizations
Your Vobiz account Auth ID
Your Vobiz account Auth Token
Path Parameters
Your account Auth ID
Example:
"MA_XXXXXX"
Currency code (e.g. INR, USD)
Example:
"INR"
Response
200 - application/json
Account balance
Was this page helpful?
⌘I
Get balance
curl --request GET \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/balance/{currency} \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/balance/{currency}"
headers = {
"X-Auth-ID": "<api-key>",
"X-Auth-Token": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/balance/{currency}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "aabbccdd-1234-5678-90ab-cdef12345678",
"account_id": "MA_XXXXXXXX",
"currency": "INR",
"balance": 23906.83,
"reserved_funds": 0,
"promotional_balance": 0,
"promotional_reserved_balance": 0,
"available_balance": 23906.83,
"credit_limit": 1000,
"is_postpaid": true,
"credit_limit_type": "soft",
"low_balance_threshold": 50,
"status": "active",
"created_at": "2026-01-19T18:39:15.050543Z",
"updated_at": "2026-05-11T06:59:32.802705Z"
}