credits

Get the credit balance

The account's available credit. billing_url is where the user adds credits, inside VoixCall. Test keys see a separate test balance seeded at 10.00. Requires credits:read.

get/credits/balance

Request

  • Base URL: https://api.voixcall.com/v1
  • URL: https://api.voixcall.com/v1/credits/balance
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://api.voixcall.com/oauth/authorize, token URL https://api.voixcall.com/oauth/token, scopes: credits:read)
    • HTTP bearer

Response

OK

amountstring required

Available credit, decimal string with two decimals.

billing_urlstring uri required

Where to add credits; opens the app or the web dashboard after login.

currency'USD' required
livemodeboolean required
low_balanceboolean required

true when the balance is below the account's low-balance threshold.

object'balance' required

Always "balance".

Changes

No recorded changes to this operation across all 1 revision of this API.