API
GET /api/billing/balance
Get Balance
GET /api/billing/balance
Get Balance
Authentication: Authorization: Bearer <key> or X-API-Key: <key>. Create keys at developers.cognitivx.io/keys.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Org-ID | header | string | null | No | - |
Example request
curl -X GET https://api.cognitivx.io/api/billing/balance \
-H "Authorization: Bearer icog_..."Example response
200 application/json
{
"balance_credits": 1,
"balance_usd": 0,
"low_balance": false,
"depleted": false
}Responses
| Status | Description |
|---|---|
200 | Success. Returns the response body shown below. |
422 | Request validation failed. detail lists each offending field. |