API v2.4 / eSIMs / Get eSIM history
GET /esims/{iccid}/history
GET
/esims/{iccid}/history
Return the history of an eSIM. Bundle Assignment States:
- Processing: The bundle assignment is currently processing. This is usually instant but can, on occasion, take up to 10 minutes to complete. The eSIM can still be installed and will register on a network while the bundle is processing.
- Queued: The bundle has been successfully assigned, has not been used yet, and is queued for use.
- Active: The bundle has successfully been used. It has data remaining and is within the bundle duration.
- Depleted: The bundle has no data remaining but is still within the bundle duration.
- Expired: The bundle has expired, and the bundle duration has been exceeded.
- Revoked: The bundle has been revoked, and is no longer on the esim.
- Lapsed: The bundle has been expired without being used, and is no longer on the esim.
Authorizations
Parameters
Path Parameters
iccid
required
string
(Required) The ICCID of the eSIM
Example
8944123456789012000
Responses
200
OK
object
name
string
bundleName
string
date
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" }]
400
Bad Request - returned when request format is not accepted
object
message
Status of api functions which do not return data
string
403
Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user
object
message
Status of api functions which do not return data
string
429
Too Many Requests
object
message
Status of api functions which do not return data
string
500
Server Error
object
message
Status of api functions which do not return data
string
503
Processing - Please come back later or use the Retry-After (seconds) header
object
message
Status of api functions which do not return data
string