API v2.5 / eSIMs / Get applied Bundle status

Server

GET

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

eSIMGo API

Provides details about an individual assignment of a Bundle applied to an eSIM.

Bundle Assignment States:

Processing: The bundle assignment is currently processing. This is usually instant but can occasionally 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.

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 exactly as shown, e.g., “esim_1GB_7D_IM_U”.
Remaining data can be found in the response.

Authorizations

apiKeyAuth

Parameters

Path Parameters

iccid

required

string

(Required) The ICCID of the eSIM

Example

8944123456789012000

name

required

string

(Required) Name of Bundle Format as defined in [List Catalogue](/api/#get-/catalogue) API call. Example: `esim_10GB_30D_IM_U`

Example

esim_10GB_30D_IM_U

Responses

200

object

assignments

Array<object>

object

ID of the bundle

string

callTypeGroup

Call Type Group of the bundle

string

initialQuantity

The initial quantity the bundle had (in bytes)

integer format: int64

remainingQuantity

The remaining quantity the bundle has (in bytes)

integer format: int64

assignmentDateTime

The date and time the bundle was created (utc string)

string format: date-time

assignmentReference

Assigment reference

string

bundleState

Current state of a bundle

string

unlimited

If the bundle is unlimited

boolean

Example

{
  "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
    }
  ]
}