List Bundles applied to an eSIM

GET

/esims/{iccid}/bundles

• eSIMGo API

Provides details about the current Bundles applied to an eSIM. Remaining data can be found here.

Each Bundle can have multiple assignments.

Authorizations

• apiKeyAuth
• apiKeyQueryAuth

Parameters

Path Parameters

iccid

required

string

The ICCID of the eSIM

Query Parameters

includeUsed

boolean

Include used Bundles

Backward compatibility for v2.1

Responses

200

Active Bundles

object

bundles

Array<object>

object

name

The name of the Bundle

string

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, will not be displayed in response if bundle has not been started)

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, will not be displayed in response if bundle has not been started and 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

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