Credit balance and the current rate

GEThttps://server.heyrik.com/api/v1/balance

Headers

AuthorizationstringRequired

Use Bearer $HEYRIK_API_KEY with an account-scoped API key. Keep the key on your server.

Get your API key

Response

Explore the example values. This is not a complete response schema.

dataobject

Explore 5 properties

credits_balancenumber

Example 2781.733

credits_usednumber

Example 218.267

minutes_balancenumber

Example 500

credits_per_minutenumber

Example 4

statusstring

Example "active"

Error reference

GET/balance

cURL

curl https://server.heyrik.com/api/v1/balance \
  -H "Authorization: Bearer $HEYRIK_API_KEY"

Response example

JSON

{
  "data": {
    "credits_balance": 2781.733,
    "credits_used": 218.267,
    "minutes_balance": 500,
    "credits_per_minute": 4,
    "status": "active"
  }
}

Illustrative examples · No live request is sent