Skip to content

Revoke a specific Bundle Assignment from an eSIM

DELETE
/esims/{iccid}/bundles/{name}/assignments/{assignmentId}

IMPORTANT:

If there are no bundles left on the eSIM AFTER the revoke, AND if the eSIM is not installed, the eSIM will undergo the eSIM Go returns process.

The start of the returns process will immediately REMOVE the eSIM from your account - you will no longer be able to access it.

After a minimum of 4 days: if during the returns process, the eSIM is now installed (e.g. by your end user), the eSIM will be returned to your account.

If you DO NOT want the eSIM to be given back to eSIM Go, ensure the eSIM either:-

  • Is installed
  • Has more than 1 bundle on it at the time of revoking

Revokes a single assignment of a given Bundle type.

e.g. Can remove 1 month from a 1-year Bundle.

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

assignmentId
required
string

ID of individual Bundle Assignment to revoke from an eSIM

Query Parameters

type
string
Allowed values: validate transaction

Type validate will provide options for the revoke and the behaviours, if any. type transaction will execute the revoke. Defaults to transaction

Responses

200

Success message

object
status

Status of Bundle

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; the user does not have any available Bundles left or the eSIM is not accessible by the user

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