GET /v1/usageCurrent billing-period API usage: requests used/remaining against the plan's monthly quota, the reset instant, and the per-key burst limit. Polling this endpoint never consumes quota.
Requires scope: pages:read or pages:write or analytics:read or contacts:read or files:read or publish. Plan entitlement: public_api (Creator and Pro).
curl "https://app.getbioflow.com/v1/usage" \
-H "Authorization: Bearer bf_live_YOUR_KEY"| Field | Type | Description |
|---|---|---|
plan | string | Workspace plan id, e.g. CREATOR |
period_start | string (ISO 8601) | — |
period_end | string (ISO 8601) | When the meter resets |
meters | array<object> | — |
burst | object | — |
Every response also carries X-Request-Id plus the IETF draft-11 RateLimit / RateLimit-Policy headers.
| Code | Status | Meaning |
|---|---|---|
invalid_request | 400 | The request body or parameters failed validation |
invalid_api_key | 401 | Missing, malformed, unknown, disabled, or expired API key |
insufficient_scope | 403 | The API key was not granted the required scope |
feature_not_enabled | 403 | The workspace plan does not include public API access |
test_key_read_only | 403 | Test-mode keys are restricted to read operations |
rate_limited | 429 | Per-key rate limit exceeded |
quota_exhausted | 429 | Monthly API quota exhausted |
internal_error | 500 | Something went wrong on our side |
All errors are RFC 9457 application/problem+json — branch on code, quote request_id to support. Full registry on the API docs hub; interactive playground in the API reference.