SORACOM Developers

Documents

SORACOM Air SIM statuses

Introduction

For SORACOM Air the following four Subscriber statuses have been defined:

Here we explain each status, what it means, and what takes place in that status.

SORACOM Air SIM statuses

Ready status

This status indicates that the SIM you purchased has been registered to your account and is now available for use. From the time that the SIM acquires this status up until the time that it transitions to another status, a charge of $0/day is applied to the SIM (When one year passes in “Ready” status, it automatically changes to “Active”).

A SIM in Ready status can be subjected to enable, disable, or termination operations through the User Console or the API core, and such operations will change the status of the SIM to Active, Inactive, or Terminated.

In addition, if a SIM in Ready status is used to carry out communication initiation processing from a device, its status will automatically transition to Active.

Active status

This status indicates that a SIM that has been purchased and registered to an account is in a state where it can be used for data communication. From the time that the SIM acquires this status up until the time that a termination operation is performed, a charge of $0.06/day is applied to the SIM.

A SIM in Active status can be subjected to invalidation or termination operations through the User Console or the API core, and such operations will change the status of the SIM to Inactive or Terminated.

Please be aware that a SIM in Active status cannot be returned to Ready status.

Inactive status

This status indicates that a SIM that has been purchased and registered to an account is in a state where it has been set to temporarily reject session establishment requests for data communication. If a device attempts to carry out data communication using a SIM in this status, it will not be possible to establish a session, so data communication will not be possible. This status can be used in situations such as when it is desired to temporarily forbid communications from the device for some reason. However, a SIM that supports SMSs can send or receive SMSs even when the SIM is in Inactive status, in which case the SIM will incur the basic fee as well as charges for SMSs sent.

Even when a SIM is in Inactive status, a 3G/LTE communications link between the device and a wireless base station can still be established. Depending on the implementation on the device side, therefore, there is a possibility that requests for the establishment of data communication sessions may be sent repeatedly. In that case there might be continuous power consumption on the device side, so we recommend adjusting the reconnection process on the device side before leaving a SIM in Inactive status inserted for a long period of time.

Example:

Please be aware that even when a SIM is in Inactive status, the SIM will incur the same basic fee as in Active status, i.e., $0.06 /day.

Suspended status

It is set to temporarily deny the session establishment request for data communication like the “Inactive” state. However, the charging system is different from the “Inactive” state. If you do not plan to use SIM for a long period of time, you may be able to keep the charge lower if you use “Suspended” rather than “Inactive”.

Setting change fee will be generated when setting to “Suspended” state from other state. In addition, the basic fee will be charged at the amount of “Suspended”. Since communication can not be performed while in this state, data communication charges do not occur.

Terminated status

This status indicates that a SIM that has been purchased and registered to an account has undergone a termination operation. At the time that a SIM acquires this status, it ceases to incur the basic fee.

A SIM in Terminated status will remain as an entry in your account for a while, but thereafter it will be completely deleted from your account.

Please be aware that a SIM in Terminated status cannot be returned to Active, Inactive, or Ready status.

Verifying SIM status by means of the API

The SORACOM Air SIM statuses explained above can be verified by means of the API, a command line interface (CLI), or a metadata service.

In the case of the API, information on the Subscriber (SIM) can be obtained by accessing the API as shown below.

https://api.soracom.io/v1/subscribers/{the SIM’s IMSI}

Information on the SIM can be obtained as shown below. (This applies in the case of CLI and metadata services as well.)

{
  "imsi": "44010xxxxxxxxxx",
  "msisdn": "81xxxxxxxxxx",
  "ipAddress": "10.xxx.xxx.xxx",
  "apn": "soracom.io",
  "type": "s1.fast",
  "groupId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "createdAt": 1437119287341,
  "lastModifiedAt": 1448436038512,
  "expiredAt": null,
  "terminationEnabled": false,
  "status": "active",
  "tags": {
    "name": "moto"
  },
  "sessionStatus": {
    "lastUpdatedAt": 1448419048209,
    "imei": "xxxxxxxxxxxxxxx",
    "location": null,
    "ueIpAddress": "10.yyy.yyy.yyy",
    "dnsServers": [
      "100.127.0.53",
      "100.127.1.53"
    ],
    "online": true
  },
  "speedClass": "s1.fast",
  "moduleType": "nano",
  "plan": 1,
  "expiryTime": null,
  "operatorId": "OPxxxxxxxxxx",
  "createdTime": 1437119287341,
  "lastModifiedTime": 1448436038512
}

The status of the SIM can be verified in the “status” value.

In addition, other information on the SIM can be obtained as shown below.

For details on how to use the API, CLI, and metadata services, please consult the links below.

Getting Started

SORACOM Air for Cellular

SORACOM Air for Sigfox

SORACOM Beam

SORACOM Canal/Direct/Door

SORACOM Endorse

SORACOM Funnel

SORACOM Gate

SORACOM Harvest

SORACOM Inventory

SORACOM Junction

SORACOM Krypton

SORACOM Lagoon

Service Detail

Developer Tools

pagetop