GET /v1/usage
Returns your team’s current render usage, quota limits, and billing period.
Endpoint:
GET /v1/usageAuthentication
Section titled “Authentication”Authorization: Bearer bp_sk_live_YOUR_KEYResponse
Section titled “Response”Status: 200 OK
{ "period": { "start": "2026-03-01T00:00:00.000Z", "end": "2026-03-31T23:59:59.999Z" }, "renders": { "live": 847, "test": 42 }, "quota": { "limit": 4500, "remaining": 3653, "hardCap": false, "stopsAt": 5400 }, "plan": "small"}Response Fields
Section titled “Response Fields”| Field | Type | Description |
|---|---|---|
period.start |
string |
Start of the current billing period (ISO 8601). |
period.end |
string |
End of the current billing period (ISO 8601). |
renders.live |
number |
Live renders used this period: live API-key renders and prints from the Bindery Press app. |
renders.test |
number |
Test renders this period (do not count against quota). |
quota.limit |
number |
Monthly render quota. -1 means unlimited. |
quota.remaining |
number |
Renders remaining before reaching the quota. |
quota.hardCap |
boolean |
true if renders are refused at the quota (Dev); false if they continue past it. |
quota.stopsAt |
number |
Live renders this period after which renders are refused: the quota on Dev, 120% of it on Small. -1 means renders never stop (Big, Enterprise). See What Happens at the Quota. |
plan |
string |
Current plan: "dev", "small", "big", or "enterprise". |
Example
Section titled “Example”curl -H "Authorization: Bearer bp_sk_live_YOUR_KEY" \ https://api.binderypress.dev/v1/usageErrors
Section titled “Errors”| Status | Code | Cause |
|---|---|---|
401 |
AUTH_REQUIRED |
Missing or invalid API key. |