GET/v1/credits
Credits
GET /v1/credits: the balance of your organization, with total credits and total usage, in US dollars and micro-dollars.
Returns the balance of the organization that owns the key, plus everything added and spent so far. Works while an account is suspended, too.
Base URL: https://api.nexrouting.com/v1 (also https://nexrouting.com/api/v1).
Headers
AuthorizationstringrequiredAuthorization: Bearer <key>(orx-api-key: <key>).
Example request
curl https://api.nexrouting.com/v1/credits \ -H "Authorization: Bearer $NEXROUTING_API_KEY"Example response
{ "data": { "currency": "USD", "balance": 42.5, "balance_micro": 42500000, "total_credits": 50, "total_usage": 7.5 }}Fields
currencystring- Always
USD. balancenumber- The balance in US dollars. Can be slightly below zero after the last request.
balance_microinteger- The same balance in micro-dollars ($1 = 1,000,000). Use this one for exact sums.
total_creditsnumber- Everything added to the balance so far: top-ups and other credits, minus refunds.
total_usagenumber- Everything spent so far, by all keys and the playground.
This request costs nothing, but counts against the key's rate limit.
Errors
401 missing_api_key, 401 invalid_api_key, 401 api_key_expired and 429 rate_limit_exceeded. See Errors.