Skip to content

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

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 the Bundle

Responses

200

Bundle status

object
Offer
object
elementId

Element Id of the offer

string
offerId

Id of the offer

string
callTypeGroup

Call Type Group of the shown offer

string
initialQuantity

The initial quantity the offer had

string
remainingQuantity

The remaining quantity the offer has

string
startTime

The time the offer started (utc string)

string
endTime

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

string

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