Usage API
Check your organization's current event usage for the billing period. Use this endpoint to monitor consumption and detect when you are approaching or exceeding your plan limits.
GET /usage
Returns the number of events ingested during the current calendar month along with overage status.
Request
No query parameters required.
Response
200 OK
{
"monthly_events": 184320,
"overage": false,
"org_id": "org_abc123",
"org_name": "Acme Corporation"
}
Response Fields
| Field | Type | Description |
|---|---|---|
monthly_events | integer | Total events ingested this calendar month |
overage | boolean | true if usage exceeds the plan threshold |
org_id | string | Organization identifier |
org_name | string | Organization name |
Example
curl -X GET "https://api.leadvibe.com/usage" \
-H "Authorization: Bearer <token>"
Common Errors
| Status | Meaning | Solution |
|---|---|---|
| 400 | Bad Request | Organization context could not be resolved |
| 401 | Unauthorized | Check authentication credentials |
Notes
- Usage is counted at the organization level across all Organizational Units
- The
overageflag is based on your plan's monthly event limit - Event counts reset at the start of each calendar month (UTC)
- Use this endpoint in dashboards or automated alerts to stay ahead of usage limits
Related Endpoints
- Events - List and manage events
- Event Stats - Get event count summaries