API v2.4 / eSIMs / Revoke specific Bundle

Server

DELETE

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

eSIM Go API

This endpoint revokes a specific bundle from an eSIM using assignment ID.

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.

IMPORTANT: Access to the refund functionality is disabled by default. To enable refunds (either to inventory or balance), you must first contact your account manager. Without this feature enabled, this endpoint will only revoke the bundle assignment without a refund.

Note: Bundle names are case sensitive and should be typed like the following “esim_1GB_7D_IM_U”.

Authorizations

apikeyAuth

Parameters

Path Parameters

iccid

required

string

(Required) The ICCID of the eSIM

Example

8944123456789012000

name

required

string

(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

assignmentId

required

string

(Required) ID of individual Bundle Assignment to revoke from an eSIM

Example

123231231

Query Parameters

type

string

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

Example

validate

refundToBalance

boolean

If Applicable, refund the value of this bundle to organisation balance

Example

true

Responses

200

object

status

Status message of api request

string

Example

{
  "status": "Successfully Revoked Bundle, bundle has been refunded to inventory"
}