API v2.4 / eSIMs / Revoke applied Bundle
DELETE /esims/{iccid}/bundles/{name}
This endpoint is used to revoke the latest assignment of a given bundle type from an eSIM. It requires two parameters: the ICCID of the eSIM and the name of the bundle to be revoked. If the specified ICCID has multiple bundles with the same name, the oldest unused bundle will be revoked.
Example: For an eSIM with ICCID 8943108165015003887 that has the following bundles:
• ESIM_1G_UK (Assignment ID: 243)
• ESIM_1G_UK (Assignment ID: 245)
• ESIM_1G_US (Assignment ID: 247)
If you revoke the “ESIM_1G_UK” bundle, the oldest unused assignment (ID: 243) will be revoked.
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
The ICCID of the eSIM
Name of Bundle Format as defined in [List Catalogue](/api/v2_4/operations/catalogue/get) API call. Example: `esim_10GB_30D_IM_U`
Query Parameters
If Applicable, refund the value of this bundle to organisation balance
If Applicable, the offerId of the bundle to revoke. needed for refunding to balance
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 message of api request
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 eSIM is not accessible by the user
object
Status of api functions which do not return data
500
Server Error
object
Status of api functions which do not return data