Usage
Get eSIM usage
Retrieves data usage for a specific eSIM. Returns total, used, and remaining data for all active packages. Usage reflects what the network has reported so far, so recent activity can take a while to appear.
/profiles/{profileReference}/esims/{esimReference}/usageAuthorization
Authorization: Bearer {token} — an OAuth2 access token from the client-credentials flow. How authentication works
Path parameters
profileReferencestringrequiredThe eSIM's profile reference (16-digit numeric string)
esimReferencestringrequiredeSIM reference identifier (18-digit opaque token)
Responses
200eSIM usage dataapplication/jsonShow response bodyHide response body
dataobjectoptionalShow propertiesHide properties
profileReferencestringoptionalesimReferencestringoptionaleSIM reference identifier (18-digit opaque token)
iccidstringoptionalpackagesarray of PackageUsageoptionalUsage details for each active package
Show propertiesHide properties
packageReferencestringPackage reference identifier (opaque token, at most 27 characters)
externalTransactionIdstring | nullThe client's external transaction ID if provided
typestringExtensible enum. Package type: data for mobile data, sms for text messaging, voice for calls, voice_sms for one allowance that calls and text messages both draw on.
datasmsvoicevoice_smsusageobjectUsage summary with unit
Show propertiesHide properties
totalnumberoptionalTotal capacity, in unit; 0 for an unlimited package
usednumberoptionalAmount used
remainingnumberoptionalAmount remaining; 0 for an unlimited package
unitstringoptionalExtensible enum. Unit of measurement: MB for data, sms for SMS, seconds for voice and units for voice and SMS.
MBsmssecondsunitstotalsobjectoptionalAggregated usage totals across all packages by type. A voice_sms package counts towards both voice and sms, since each of its units is a call minute or an SMS.
Show propertiesHide properties
dataobject | nullAggregated data usage (unit MB), null if no data packages
Show propertiesHide properties
totalnumberoptionalTotal capacity, in unit; 0 for an unlimited package
usednumberoptionalAmount used
remainingnumberoptionalAmount remaining; 0 for an unlimited package
unitstringoptionalExtensible enum. Unit of measurement: MB for data, sms for SMS, seconds for voice and units for voice and SMS.
MBsmssecondsunitssmsobject | nullAggregated SMS usage (unit sms), a voice_sms unit counting as one SMS; null if no SMS or voice_sms packages
Show propertiesHide properties
totalnumberoptionalTotal capacity, in unit; 0 for an unlimited package
usednumberoptionalAmount used
remainingnumberoptionalAmount remaining; 0 for an unlimited package
unitstringoptionalExtensible enum. Unit of measurement: MB for data, sms for SMS, seconds for voice and units for voice and SMS.
MBsmssecondsunitsvoiceobject | nullAggregated voice usage (unit seconds), a voice_sms unit counting as 60 seconds; null if no voice or voice_sms packages
Show propertiesHide properties
totalnumberoptionalTotal capacity, in unit; 0 for an unlimited package
usednumberoptionalAmount used
remainingnumberoptionalAmount remaining; 0 for an unlimited package
unitstringoptionalExtensible enum. Unit of measurement: MB for data, sms for SMS, seconds for voice and units for voice and SMS.
MBsmssecondsunits401Unauthorized - missing or invalid API key403Forbidden - client does not have access to this resource404Resource not found429Rate limit exceeded. A `429` can also arrive without these headers or this body; handle it by its status code.500Internal server error