Request
curl https://api.beaconbox.eu/api/v1/credits \
-H "Authorization: Bearer $BEACONBOX_API_KEY"client.credits.balance()$client->credits->balance()Response
Returns 200.
| Field | Type | Description |
|---|---|---|
balance | integer | Message credits remaining. One credit sends one message on whichever channel carries it; a single balance covers SMS today and WhatsApp when that channel opens. |
low_balance | boolean | True below the low-balance threshold. SMS stops at zero; email is unaffected. |
threshold | integer |
Errors
Failures are { "error_code": "..." } with a stable dotted code. See Errors for the codes worth branching on and the three outcomes that look like failures and are not.