Skip to content
eSIM Go Developer Docs

Get applied Bundle status

GET
/esims/{iccid}/bundles/{name}

Provides details about an individual assignment of a Bundle applied to an eSIM. Remaining data can be found here. Each Bundle can have multiple assignments. e.g. a 1-year Bundle will have 12 assignments, each with their own start and finish dates 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. Notes: - If multiple of the same bundle are applied to a single eSIM, the status bundle with the latest assignment will be returned. - Bundle names are case sensitive and should be typed like the following “esim_1GB_7D_IM_U”.

Authorizations

Parameters

Path Parameters

iccid
required
string

(Required) The ICCID of the eSIM

Example
<string>
name
required
string

(Required) Name of Bundle Format as defined in List Catalogue API call. Example: esim_10GB_30D_IM_U

Example
<string>

Responses

200

OK

object
Example
{
  "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>"
}