API v2.4 / eSIMs / Get eSIM history

Server

GET

/esims/{iccid}/history

eSIM Go API

This endpoint returns the history of a specific eSIM. It provides a chronological list of actions performed on the eSIM, including bundle assignments and their states.

This endpoint is useful for tracking the lifecycle of an eSIM, including bundle assignments, updates, and other significant events.

Bundle Assignment States:

Bundle Applied: The bundle has been successfully assigned to the eSIM
eSIM Updated: The eSIM Reference has been updated.
eSIM Refreshed: eSIM was forcibly disconnected from the network, prompting it to reestablish its connection.
eSIM Utilisation Alert: A notification has been triggered due to the eSIM reaching a certain usage threshold.
eSIM Returned: The eSIM is no longer assigned to your organisation after undergoing the returns process.
Bundle Refunded To Balance: The unused bundle has been credited back to the organization’s account balance.
Bundle Refunded to Inventory: The unused bundle has been returned to the organization’s inventory for potential reassignment.
Bundle Revoked: The bundle has been removed from the eSIM.
eSIM First Attachment: The eSIM has successfully connected to a mobile network for the first time since activation.
eSIM First Use: The eSIM has been used for the first time to consume data service.
Bundle Expired: The bundle’s validity period has ended and/or has been used in full. It is no longer active or usable.
Bundle Lapsed: The bundle has become inactive after no activity for 12 months.

Authorizations

apikeyAuth

Parameters

Path Parameters

iccid

required

string

(Required) The ICCID of the eSIM

Example

8944123456789012000

Responses

200

object

name

Bundle Assignment State

string

bundleName

Bundle name

string

date

Action date and time

string

Example

[
  {
    "name": "Bundle Applied",
    "bundleName": "A_BUNDLE_20GB_30D_EU_U",
    "date": "2023-04-07T00:50:31.618780311Z"
  },
  {
    "name": "Bundle Revoked",
    "bundleName": "A_BUNDLE_20GB_30D_EU_U",
    "date": "2023-04-07T00:50:31.618780311Z"
  }
]