List eSIM usage history
Lists the recorded usage readings of an eSIM, newest first.
Lists the recorded usage readings of an eSIM, newest first.
Returns { items, pagination }, one item per usage reading, with its allowances, remaining amounts and
usage and expiry bands. from and to limit the readings by capturedAt, both inclusive. An
ICCID that is not one of your eSIMs gives 404 / 10004.
PartnerApiKeyX-Partner-Key<token>Partner API Key (X-Partner-Key)
iccid*stringThe eSIM's ICCID, from the order item's fulfillment.result.details.iccid.
page?integerPage number, from 1; default 1.
int321limit?integerPage size, 1 to 100; default 10.
int3210from?stringOnly readings captured at or after this UTC time. ISO 8601 date-time. A value with Z or an offset is converted to UTC; a value without a zone is read as UTC, and a date alone means 00:00 UTC on that day.
date-timeto?stringOnly readings captured at or before this UTC time. ISO 8601 date-time. A value with Z or an offset is converted to UTC; a value without a zone is read as UTC, and a date alone means 00:00 UTC on that day.
date-timeOK
- response
A page of an eSIM's usage readings, newest first.
items*array<>pagination*Paging of a list response.
curl -X GET 'https://api.sandbox.openroam.com/v1/esims/8944501234567890123/usage/history?page=1&limit=10&from=2026-10-01T00%3A00%3A00Z&to=2026-10-31T23%3A59%3A59Z'{ "items": [ { "iccid": "string", "esimStatus": "new", "capturedAt": "2019-08-24T14:15:22Z", "start": "2019-08-24T14:15:22Z", "end": "2019-08-24T14:15:22Z", "usageBand": "none", "expiryBand": "none", "allowedData": 0, "remainingData": 0, "isDataUnlimited": true, "allowedSms": 0, "remainingSms": 0, "isSmsUnlimited": true, "allowedVoice": 0, "remainingVoice": 0, "isVoiceUnlimited": true } ], "pagination": { "currentCount": 0, "totalCount": 0, "skip": 0, "limit": 0, "hasMore": true, "page": 0, "totalPages": 0 }}Get eSIM usage by day GET
Returns the current usage of an eSIM with a per-day breakdown. Returns the same summary as `usage` plus `usages`, the per-day consumption entries `{ date, usage, location }` with the data used in MB and `location` null when no country was reported. `usages` is empty when the eSIM's plan does not report a per-day breakdown or it cannot be read.
Get eSIM usage GET
Returns the current data, SMS and voice usage of an eSIM. Reads the live usage when the request is made and returns `esimStatus`, `profileStatus` and the allowed and remaining data (MB), SMS (messages) and voice (minutes), including top-ups. An amount is null when it is unlimited (`isDataUnlimited`, `isSmsUnlimited`, `isVoiceUnlimited`), not reported or not included. When the usage cannot be read live, or the plan does not report live usage, it returns the last known usage. An ICCID that is not one of your eSIMs gives 404 / 10004.