Firsty

Search...

Search...

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.

get/profiles/{profileReference}/esims/{esimReference}/usage

Authorization

Authorization: Bearer {token} — an OAuth2 access token from the client-credentials flow. How authentication works

Path parameters

profileReferencestringrequired

The eSIM's profile reference (16-digit numeric string)

esimReferencestringrequired

eSIM reference identifier (18-digit opaque token)

Responses

200eSIM usage dataapplication/json
Show response body
dataobjectoptional
Show properties
profileReferencestringoptional
esimReferencestringoptional

eSIM reference identifier (18-digit opaque token)

iccidstringoptional
packagesarray of PackageUsageoptional

Usage details for each active package

Show properties
packageReferencestring

Package reference identifier (opaque token, at most 27 characters)

externalTransactionIdstring | null

The client's external transaction ID if provided

typestring

Extensible 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.

Examplesdatasmsvoicevoice_sms
usageobject

Usage summary with unit

Show properties
totalnumberoptional

Total capacity, in unit; 0 for an unlimited package

usednumberoptional

Amount used

remainingnumberoptional

Amount remaining; 0 for an unlimited package

unitstringoptional

Extensible enum. Unit of measurement: MB for data, sms for SMS, seconds for voice and units for voice and SMS.

ExamplesMBsmssecondsunits
totalsobjectoptional

Aggregated 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 properties
dataobject | null

Aggregated data usage (unit MB), null if no data packages

Show properties
totalnumberoptional

Total capacity, in unit; 0 for an unlimited package

usednumberoptional

Amount used

remainingnumberoptional

Amount remaining; 0 for an unlimited package

unitstringoptional

Extensible enum. Unit of measurement: MB for data, sms for SMS, seconds for voice and units for voice and SMS.

ExamplesMBsmssecondsunits
smsobject | null

Aggregated SMS usage (unit sms), a voice_sms unit counting as one SMS; null if no SMS or voice_sms packages

Show properties
totalnumberoptional

Total capacity, in unit; 0 for an unlimited package

usednumberoptional

Amount used

remainingnumberoptional

Amount remaining; 0 for an unlimited package

unitstringoptional

Extensible enum. Unit of measurement: MB for data, sms for SMS, seconds for voice and units for voice and SMS.

ExamplesMBsmssecondsunits
voiceobject | null

Aggregated voice usage (unit seconds), a voice_sms unit counting as 60 seconds; null if no voice or voice_sms packages

Show properties
totalnumberoptional

Total capacity, in unit; 0 for an unlimited package

usednumberoptional

Amount used

remainingnumberoptional

Amount remaining; 0 for an unlimited package

unitstringoptional

Extensible enum. Unit of measurement: MB for data, sms for SMS, seconds for voice and units for voice and SMS.

ExamplesMBsmssecondsunits
401Unauthorized - 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