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": 10000, "remaining": 9153, "hardCap": true }, "plan": "starter"}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. |
renders.test | number | Test renders this period (do not count against quota). |
quota.limit | number | Monthly render limit. -1 means unlimited. |
quota.remaining | number | Renders remaining before hitting the limit. |
quota.hardCap | boolean | true if renders are rejected at the limit; false if they continue with a warning. |
plan | string | Current plan: "dev", "starter", "pro", 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. |