API v2.4 / eSIMs / List Bundles applied to eSIM

Server

GET

/esims/{iccid}/bundles

eSIM Go API

Provides details about the current Bundles applied to an eSIM. Remaining data can be found here. Each Bundle can have multiple assignments. 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 expired without being used and is no longer on the eSIM.

Authorizations

apikeyAuth

Parameters

Path Parameters

iccid

required

string

(Required) The ICCID of the eSIM

Example

8944123456789012000

Query Parameters

includeUsed

string

Include used & expired Bundles Backward compatibility for v2.1

Example

true

limit

string

Number of assignments to return. Must be between 1 and 200. Default is 15

Example

Responses

200

object

bundles

Array<object>

object

name

string

description

string

assignments

Array<object>

object

string

callTypeGroup

string

initialQuantity

integer

remainingQuantity

integer

assignmentDateTime

string format: date-time

assignmentReference

string

bundleState

string

unlimited

boolean

Example

{
  "bundles": [
    {
      "name": "esim_1GB_7D_GB_V2",
      "description": "eSIM, 1GB, 7 Days, United Kingdom, V2",
      "assignments": [
        {
          "id": "215009266",
          "callTypeGroup": "data",
          "initialQuantity": 1000000000,
          "remainingQuantity": 1000000000,
          "assignmentDateTime": "2024-12-11T10:47:00.34523Z",
          "assignmentReference": "3a6e2e40-c674-45e9-b289-b35027bf72a9-0",
          "bundleState": "queued",
          "unlimited": false
        }
      ]
    }
  ]
}