Skip to content
eSIM Go Developer Docs

List Bundles applied to eSIM

GET
/esims/{iccid}/bundles

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.

Authorizations

Parameters

Path Parameters

iccid
required
string

(Required) The ICCID of the eSIM

Example
<string>

Query Parameters

includeUsed
string

Include used & expired Bundles Backward compatibility for v2.1

Example
<boolean>
limit
string

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

Example
<integer>

Responses

200

OK

object
Example
{
  "bundles": [
    {
      "name": "<string>",
      "assignments": [
        {
          "id": "<string>",
          "callTypeGroup": "<string>",
          "initialQuantity": "<integer>",
          "remainingQuantity": "<integer>",
          "startTime": "<dateTime>",
          "endTime": "<dateTime>",
          "bundleState": "<string>",
          "assignmentDateTime": "<dateTime>",
          "assignmentReference": "<string>",
          "unlimited": "<boolean>"
        },
        {
          "id": "<string>",
          "callTypeGroup": "<string>",
          "initialQuantity": "<integer>",
          "remainingQuantity": "<integer>",
          "startTime": "<dateTime>",
          "endTime": "<dateTime>",
          "bundleState": "<string>",
          "assignmentDateTime": "<dateTime>",
          "assignmentReference": "<string>",
          "unlimited": "<boolean>"
        }
      ]
    },
    {
      "name": "<string>",
      "assignments": [
        {
          "id": "<string>",
          "callTypeGroup": "<string>",
          "initialQuantity": "<integer>",
          "remainingQuantity": "<integer>",
          "startTime": "<dateTime>",
          "endTime": "<dateTime>",
          "bundleState": "<string>",
          "assignmentDateTime": "<dateTime>",
          "assignmentReference": "<string>",
          "unlimited": "<boolean>"
        },
        {
          "id": "<string>",
          "callTypeGroup": "<string>",
          "initialQuantity": "<integer>",
          "remainingQuantity": "<integer>",
          "startTime": "<dateTime>",
          "endTime": "<dateTime>",
          "bundleState": "<string>",
          "assignmentDateTime": "<dateTime>",
          "assignmentReference": "<string>",
          "unlimited": "<boolean>"
        }
      ]
    }
  ]
}

400

Bad Request

object
Example
{
  "message": "<string>"
}

403

Forbidden

object
Example
{
  "message": "<string>"
}

500

Internal Server Error

object
Example
{
  "message": "<string>"
}