Get balance

Obtain balance owed to Voiso for contact center services.

The Get balance endpoint returns the current balance owed to

Voiso
for contact center services.

Requirements: Base URL, Authentication, Error codes

Scope: billing.balance.read

What this does

When you send a Get balance request,

Voiso
returns a balance object that includes the amount.

Endpoint


GET /api/v4/billing/balance

Example request

curl -X GET "https://{cluster_id}.voiso.com/api/v4/billing/balance" \
  -H "Authorization: Bearer <contact_center_api_key>" \
  -H "Content-Type: application/json"

Response

If successful, the API returns the contact center balance.

{
  "balance": {
    "amount": "100.12"
  }
}

Notes

  • amount is returned as a string.

Troubleshooting

401 Unauthorized

What to check:

  • You are sending Authorization: Bearer <contact_center_api_key>.

403 Forbidden

What to check:

  • The API key is valid, but does not have access to billing resources in this contact center.

429 Too many requests

What to do:

  • Reduce request frequency and retry with backoff.
Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json