SubscriptionUsageResponse
Usage metrics with limits.
ISO 8601 datetime
ISO 8601 datetime
usage objectrequired
Current usage metrics.
0Metered event count for the current month, from period_start to period_end
00000limits objectrequired
Usage limits for a subscription plan.
Monthly API call limit (-1 for unlimited)
Monthly event limit (-1 for unlimited)
Maximum number of geofences (-1 for unlimited)
Monthly webhook delivery limit (-1 for unlimited)
Monthly test point limit (-1 for unlimited)
Requests an hour the API enforces per key or login, the same for every plan
Maximum devices per workspace (-1 for unlimited)
5Maximum workflows per workspace (-1 for unlimited)
2Workflow log retention in days (-1 for unlimited)
7Location history retention in days
90Current throttle status: ok, warning, alert, throttled, blocked
okWhether workspace is in its first billing month
false{
"is_first_billing_month": false,
"limits": {
"api_calls": 600000,
"devices": 15,
"events": 600000,
"geofences": 100,
"location_retention_days": 90,
"log_retention_days": 30,
"rate_limit_per_hour": 1000,
"test_points": 600000,
"webhooks_delivered": 2
},
"period_end": "2025-11-01T00:00:00Z",
"period_start": "2025-10-01T00:00:00Z",
"plan_name": "Pro",
"throttle_status": "ok",
"usage": {
"api_calls": 12450,
"events": 18720,
"geofences": 38,
"test_points": 3200,
"webhooks_delivered": 8720
},
"user_id": "u1a2b3c4-d5e6-7890-abcd-ef1234567890"
}