Check Usage

View as Markdown

Get esim usage by id. Usage and status are polled from the upstream provider at most once every 5 minutes; within that window the last known values are returned unless force is set.

Authentication

x-api-keystring

API key generated from the dashboard (Settings → API Keys). Each key is limited to 8 requests per 1-second window.

Path parameters

idstringRequired

Query parameters

forcebooleanOptional
Poll the upstream provider even if the eSIM was refreshed within the last 5 minutes.

Response

Successful response
dataUsagedouble
totalDatadouble
lastDataUsageUpdateTimestring or null
esimStatusstring or null

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error