API v3

GET /balance

Wholesale balance and prepaid dip balance.

Addresshttps://api.voicepro.plus/v3/balance
Key permissionbilling:read

Example

curl -X GET "https://api.voicepro.plus/v3/balance" \
  -H "Authorization: Bearer vpkey_YOUR_KEY"
Response
{
  "object": "balance",
  "wholesale": [
    {
      "amount": 4850,
      "currency": "USD"
    }
  ],
  "prepaid": [
    {
      "amount": 2500,
      "currency": "GBP"
    },
    {
      "amount": 12000,
      "currency": "USD"
    }
  ],
  "default_currency": "GBP",
  "data_as_of": "2026-10-28T09:00:00Z"
}

Errors

Every error has the same shape: { "error": { "type", "code", "message", "param", "request_id" } }.

missing_api_key401: No Authorization header, or not a Bearer key.
invalid_api_key401: The key is not recognised.
api_key_revoked401: The key was revoked in the portal.
api_key_expired401: The key passed the expiry date set on it.
missing_scope403: The key lacks the scope this endpoint needs; param names the scope.
ip_not_allowed403: The key has an IP allowlist and this request came from elsewhere.
account_not_active403: The workspace is suspended or closed.
rate_limited429: Too many requests for this key or for the whole account (the message says which); wait Retry-After seconds.
internal_error500: Our fault. Quote the request_id to support.

More in Billing