GET /v1/usage

Returns your team’s current render usage, quota limits, and billing period.

Endpoint:

GET /v1/usage

Authentication

Authorization: Bearer bp_sk_live_YOUR_KEY

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

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 API-key renders used this period. Renders from the Bindery Press app don’t count.
`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

curl -H "Authorization: Bearer bp_sk_live_YOUR_KEY" \
  https://api.binderypress.dev/v1/usage

Errors

Status	Code	Cause
`401`	`AUTH_REQUIRED`	Missing or invalid API key.