Packages
Get package history
Retrieves a paginated list of all packages for a specific eSIM, including expired and removed packages. Includes usage data for each package. Results are sorted by creation date (newest first).
/profiles/{profileReference}/esims/{esimReference}/packages/historyAuthorization
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)
Query parameters
limitintegerMaximum number of items to return (1-100)
20cursorstringOpaque cursor token for fetching the next page. Pass the nextCursor value from a previous response.
Responses
200Package historyapplication/jsonShow response bodyHide response body
dataarray of PackageHistoryItemShow propertiesHide properties
packageReferencestringPackage reference identifier (23-character opaque token)
externalTransactionIdstring | nullThe client's external transaction ID if provided
planReferencestringPlan reference identifier (14-character opaque token)
typestringPackage type: data for mobile data, sms for text messaging, voice for calls
datasmsvoicecountryCodestringstatusstringactivethrottledexhaustedexpiredremovedrecurringbooleanWhether this package was set to auto-renew
usedAmountnumberAmount of data used in MB.
remainingAmountnumber | nullAmount of data remaining in MB. Null when not determinable.
usageUpdatedAtstring | null · date-timeWhen usage was last updated
activatedAtstring | null · date-timeexpiresAtstring | null · date-timecreatedAtstring · date-timepaginationobjectShow propertiesHide properties
limitintegerrequiredMaximum items per page
hasMorebooleanrequiredWhether there are more items after this page
nextCursorstring | nullrequiredOpaque cursor token for the next page. Null when there are no more results.
401Unauthorized - missing or invalid API key403Forbidden - client does not have access to this resource404Resource not found429Rate limit exceeded500Internal server error