Get eSIM usage by day
Returns the current usage of an eSIM with a per-day breakdown.
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.
PartnerApiKeyX-Partner-Key<token>Partner API Key (X-Partner-Key)
iccid*stringThe eSIM's ICCID, from the order item's fulfillment.result.details.iccid.
OK
- response
An eSIM's current usage, as usage returns it, with a per-day breakdown.
iccid*stringThe eSIM's ICCID.
esimStatus*stringThe eSIM's lifecycle status, as the order item's esimStatus.
"new""procuring""pending""failed""ready""cancelled""revoked""expired""unknown"profileStatus*stringThe installed profile's status, as the order item's profileStatus.
"empty""new""downloaded""installed""activated""inactive""deleted""revoked""expired""unknown"start?|When the plan started, in UTC; null until it is activated.
date-timeend?|When the plan ends, in UTC, as last reported; null while no end is reported.
date-timeallowedData?|Total data in MB; null when unlimited or not reported.
int64remainingData?|Remaining data in MB; null when unlimited or not reported.
int64isDataUnlimited*booleanWhether the data is unlimited.
allowedSms?|Total SMS, in messages; null when unlimited, not reported or not included.
int64remainingSms?|Remaining SMS, in messages; null when unlimited, not reported or not included.
int64isSmsUnlimited*booleanWhether SMS are unlimited.
allowedVoice?|Total voice, in minutes; null when unlimited, not reported or not included.
int64remainingVoice?|Remaining voice, in whole minutes; null when unlimited, not reported or not included.
int64isVoiceUnlimited*booleanWhether voice is unlimited.
usages*array<>Per-day usage, empty when the plan does not report a per-day breakdown.
curl -X GET 'https://api.sandbox.openroam.com/v1/esims/8944501234567890123/usage/details'{ "iccid": "string", "esimStatus": "new", "profileStatus": "empty", "start": "2019-08-24T14:15:22Z", "end": "2019-08-24T14:15:22Z", "allowedData": 0, "remainingData": 0, "isDataUnlimited": true, "allowedSms": 0, "remainingSms": 0, "isSmsUnlimited": true, "allowedVoice": 0, "remainingVoice": 0, "isVoiceUnlimited": true, "usages": [ { "date": "2019-08-24", "start": "2019-08-24T14:15:22Z", "end": "2019-08-24T14:15:22Z", "usage": 0, "location": "string" } ]}List eSIM status events GET
Lists the status changes of an eSIM, newest first. Returns `{ items, pagination }`, one item per status change with `esimStatus`, `profileStatus` and `occurredAt`. `from` and `to` limit the events by `occurredAt`, both inclusive. An ICCID that is not one of your eSIMs gives 404 / 10004.
List eSIM usage history GET
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.