Soracom Air for Cellular

Terminating Soracom IoT SIMs

When you no longer need your Soracom IoT SIM, you can terminate the subscription from the User Console, or programmatically using the Soracom API, Soracom CLI, or Metadata Service. Termination also gives you the ability to remotely terminate an IoT SIM, in order to prevent misuse and unwanted billing in case of loss.

Terminating a Soracom IoT SIM is a permanent, irreversible action. Once an IoT SIM is terminated, it cannot be used for network connections or SMS functionality, and it cannot be re-activated. For security reasons, Soracom staff can not terminate SIMs on the behalf of customers.

Terminating a SIM

  1. Login to the User Console. From the Menu, open the SIM Management screen.

  2. From the list of subscribers, click the for the SIM you want to terminate.

  3. Click the Actions menu, then select Terminate.

    https://console.soracom.io

    Terminate

  4. A warning will appear to confirm the action. If you have Termination Protection enabled, you will be required to disable it before terminating the SIM. Click Terminate to confirm.

    Terminate SIM

Once your SIM has been terminated, it will remain visible in your account for a certain period of time, and automatically be removed afterwards.

Termination Protection

To prevent accidental termination, you can enable the Termation protection option. With Termination protection enabled, you will be asked to disable protection in order to confirm the termination action.

To enable Termination protection:

  1. Login to the User Console. From the Menu, open the SIM Management screen.

  2. From the list of subscribers, click the for the SIM you want to modify.

  3. Click the Actions menu, then select Change termination protection.

    https://console.soracom.io

    Change termination protection

  4. From the Change termination protection dialog, click the toggle button to turn Termination Protection ON, then click Change.

    Termination Protection

Programmatic Usage

You can terminate SIMs and enable or disable termination protection using the Soracom API, Soracom CLI, and Metadata Service.

Soracom API

To access the Soracom API, first use the auth API to obtain an API Key and Token. Refer to the API Reference Guide for instructions on how to use the API Key and Token in API requests.

Then, use the terminateSubscriber API to terminate an IoT SIM:

curl -X POST \
>  -H 'X-Soracom-API-Key: <MY-API-KEY>' \
>  -H 'X-Soracom-Token: <MY-TOKEN>' \
>  https://g.api.soracom.io/v1/subscribers/<IMSI>/terminate

Enabling or disabling termination protection is done similarly with the following APIs:

Soracom CLI

Then, run the following command to terminate an IoT SIM:

soracom subscribers terminate --imsi <IMSI> --coverage-type g

Enabling or disabling termination protection is done similarly with the following commands:

  • soracom subscribers enable-termination
  • soracom subscribers disable-termination

Metadata Service

The Metadata Service allows an Air SIM device to access and configure its own settings without the need for authentication. For more information, refer to the Metadata Service documentation.

In order for an IoT SIM to terminate its own subscription or modify its termination protection setting, the Metadata Service Readonly option must be disabled. Then, use the same endpoints that correspond to the Soracom Subscriber API.

To make an IoT SIM terminate its own subscription, use the terminateSubscriber API:

curl -X POST http://metadata.soracom.io/v1/subscriber/terminate

When calling the terminateSubscriber API, the subscription will be terminated and the device will no longer be able to connect.

Enabling or disabling termination protection is done similarly with the following APIs: