Skip to main content

SubscriptionUsageResponse

Usage metrics with limits.

user_idUser Id (string)required
period_startPeriod Start (string)required

ISO 8601 datetime

period_endPeriod End (string)required

ISO 8601 datetime

usage objectrequired

Current usage metrics.

api_callsApi Calls (integer)
Default value: 0
eventsEvents (integer)

Metered event count for the current month, from period_start to period_end

Default value: 0
geofencesGeofences (integer)
Default value: 0
webhooks_deliveredWebhooks Delivered (integer)
Default value: 0
test_pointsTest Points (integer)
Default value: 0
devicesDevices (integer)
Default value: 0
limits objectrequired

Usage limits for a subscription plan.

api_callsApi Calls (integer)required

Monthly API call limit (-1 for unlimited)

eventsEvents (integer)required

Monthly event limit (-1 for unlimited)

geofencesGeofences (integer)required

Maximum number of geofences (-1 for unlimited)

webhooks_deliveredWebhooks Delivered (integer)required

Monthly webhook delivery limit (-1 for unlimited)

test_pointsTest Points (integer)required

Monthly test point limit (-1 for unlimited)

rate_limit_per_hourRate Limit Per Hour (integer)required

Requests an hour the API enforces per key or login, the same for every plan

devicesDevices (integer)

Maximum devices per workspace (-1 for unlimited)

Default value: 5
workflowsWorkflows (integer)

Maximum workflows per workspace (-1 for unlimited)

Default value: 2
log_retention_daysLog Retention Days (integer)

Workflow log retention in days (-1 for unlimited)

Default value: 7
location_retention_daysLocation Retention Days (integer)

Location history retention in days

Default value: 90
plan_namePlan Name (string)required
throttle_statusThrottle Status (string)

Current throttle status: ok, warning, alert, throttled, blocked

Default value: ok
is_first_billing_monthIs First Billing Month (boolean)

Whether workspace is in its first billing month

Default value: false
SubscriptionUsageResponse
{
"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"
}