Skip to content
eSIM Go Developer Docs

Get the status of a Bundle applied to an eSIM

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

The ICCID of the eSIM

name
required
string

Name of Bundle

Format as defined in List Catalogue API call. Example: esim_10GB_30D_IM_U

Responses

200

Bundle status

object
assignments
Array<object>
object
id

Id of the assignment

string
callTypeGroup

Call Type Group of the assignment

string
initialQuantity

The initial quantity the assignment had

integer format: float
remainingQuantity

The remaining quantity the assignment has

integer format: float
startTime

The time the assignment started (utc string)

Format as defined in RFC 3339, section 5.6. Timezone is UTC (ends with ‘Z’). Example: 2006-01-02T15:04:05Z

string format: date-time
endTime

The time the assignment ended (utc string, can be empty if assignment has no endTime)

Format as defined in RFC 3339, section 5.6. Timezone is UTC (ends with ‘Z’). Example: 2006-01-02T15:04:05Z

string format: date-time
bundleState

Current state of a bundle. Supported: processing,queued, active, depleted, expired, revoked

string
assignmentDateTime

The time the assignment was created (utc string)

Format as defined in RFC 3339, section 5.6. Timezone is UTC (ends with ‘Z’). Example: 2006-01-02T15:04:05Z

string format: date-time
assignmentReference

Assignment reference

string
unlimited

If the bundle is unlimited

boolean

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 or that the user does not have permission to query the given ICCID

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