Endpoints
Current Monthly Usage
Inspect the calling API key's monthly usage, quota, percent used, plan tier, and quota reset timestamp.
GET /api/v1/account/usage
Returns the calling key's current calendar-month usage. Useful for client-side dashboards, quota warning banners, and pre-flight rate-limit budgeting.
Authentication
curl -H "X-API-Key: fbapi_live_..." \
"https://api.floridabusinessapi.com/v1/account/usage"
Query Parameters
None.
Response (200)
{
"data": {
"events_count": 1247,
"monthly_quota": 10000,
"percent_used": 12.47,
"reset_date": "2026-07-01T00:00:00.000Z",
"plan": "pro"
},
"meta": { "request_id": "req_1234567890abcdef12345" }
}
| Field | Type | Description |
|---|---|---|
events_count | integer | Successful API-usage events counted this calendar month (UTC). |
monthly_quota | integer | The key's monthly quota (per plan tier). |
percent_used | number (2 decimals) | events_count / monthly_quota * 100. Zero when quota is unlimited. |
reset_date | ISO 8601 timestamp | UTC start of next calendar month (when the counter resets). |
plan | string | Plan tier (e.g. free, pro, enterprise). |
Error Responses
| Status | Code | Cause |
|---|---|---|
401 | unauthorized | Missing or invalid API key. |
429 | rate_limited | Rate limit exceeded. |
500 | internal_error | Server error — retry with backoff. |