API v2.4 / eSIMs / Revoke specific Bundle
DELETE /esims/{iccid}/bundles/{name}/assignments/{assignmentId}
This endpoint revokes a specific bundle from an eSIM using assignment ID.
IMPORTANT: If there are no bundles left on the eSIM AFTER the revoke, AND if the eSIM is not installed, the eSIM may undergo the eSIM Go returns process. The start of the returns process will 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 latest assignment of a given Bundle type. If a bundle assignment has not been started and no data has been consumed, the bundle assignment can either be returned to the inventory or credited back to the organisations balance. If the bundle assignment has started, or was purchased outside of their permitted refund period, typically 60 days, it cannot be returned to the inventory or taken as a credit.
Note: Bundle names are case sensitive and should be typed like the following “esim_1GB_7D_IM_U”.
Authorizations
Parameters
Path Parameters
(Required) The ICCID of the eSIM
Example
8944123456789012000
(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
(Required) ID of individual Bundle Assignment to revoke from an eSIM
Example
123231231
Query Parameters
type `validate` will provide options for the revoke and the behaviours, if any. type `transaction` will execute the revoke. Defaults to `transaction`
Example
validate
Responses
200
OK
object
Status message of api request
Example
{ "status": "Successfully Revoked Bundle, bundle has been refunded to inventory"}
400
Bad Request - returned when request format is not accepted
object
Status of api functions which do not return data
403
Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user
object
Status of api functions which do not return data
429
Too Many Requests
object
Status of api functions which do not return data
500
Server Error
object
Status of api functions which do not return data
503
Processing - Please come back later or use the Retry-After (seconds) header
object
Status of api functions which do not return data