API v2.3 / eSIMs / Revokes latest assignment of given bundle to an eSIM
DELETE /esims/{iccid}/bundles/{name}
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 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/#get-/catalogue) 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 of Bundle
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