BixelDocs
API reference

Your remaining credits and PAYG balance

GET
/v1/usage

The caller's own meter: plan-credit limit, used, remaining, the monthly reset time (unix seconds), the prepaid pay-as-you-go balance and monthly cap, and the per-call weights (current-state 1, history/diff 3). Costs 0 credits - check it before a large pull so you never discover exhaustion mid-run. Prepaid by construction: nothing bills after the fact.

Authorization

AuthorizationBearer <token>

bx_-prefixed API key. Free keys: https://bixel.com/account/

In: header

Response Body

application/json

curl -X GET "https://example.com/v1/usage"
{  "data": {    "tier": "free",    "credits": {      "limit": 0,      "used": 0,      "remaining": 0,      "reset": 0    },    "payg": {      "balance_credits": 0,      "monthly_cap_credits": 0    },    "weights": {      "current": 0,      "historical": 0    }  },  "meta": {    "as_of": "2019-08-24T14:15:22Z"  }}
Empty