IoT optional statuses

Learn how to manage the status of your IoT subscribers with their dedicated APIs

IoT subscriber lifecycle with optional statuses

IoT customers may get optional statuses in order to easily manage their fleet in accordance with their use case. In this documentation, you will find how to deal with test mode and tariff holiday.

Let's start with the lifecycle including these IoT specific statuses.

Subscriber IoT lifecycle

Subscriber statuses

Mandatory statuses

StatusDescriptionNetwork servicesBilling status
available_status_imgAvailableSIM card is ready to be activatedInactiveInactive
active_status_imgActiveSubscriber is fully activated in all systemsActiveActive
suspended_status_imgSuspendedNetwork services are suspendedInactiveActive
terminated_status_imgTerminatedSubscriber and related SIM card are terminated in all systemsInactiveInactive

IoT specific statuses

StatusDescriptionNetwork servicesBilling status
test_mode_status_imgTestModeThis status gives the subscriber a quota of data & SMS to be used for a specific period of time before becoming activeActiveInactive
tariff_holiday_status_imageTariff_HolidayThis status allows Transatel customers to pause a subscriber from a network and billing perspectiveInactiveInactive

The availability of the above statuses may depend on your offer. Please reach out to your account manager for more information.

IoT optional statuses management

The IoT optional statuses are manageable through API and as other statuses transitions (automated or manual), they generate events.

Test mode management

Test mode is interesting when dealing with logistics. The use of this mode allows you to conduct device and connectivity testing prior to device deployment. When this option has been set in your offer, all your activation orders are leading to test mode status. Test mode provides a quota (data, voice, sms) and a period for your testing at limited costs.

The quota and period depends on your offer. Please reach out to your account manager if you need more information.

Exit Test mode

A subscriber exit test mode either:

  • Automatically when allowed period is expired or quota is exhausted
  • Manually by requesting an exit via the dedicated operation

When exiting test mode, the subscriber will move to either Active or TestMode status, depending on the default behavior defined in your offer. As for activation, if you force the exit via the API operation then you're also able to choose the target status thanks to the newStatus parameter.

An exit test mode always generates an exit test mode event.

Tariff holiday management

If your subscriber is bound to an offer with tariff holiday, you can switch it to this mode during a period of inactivity in order to reduce recurring and usage fees. As a consequence, network services are suspended while in this mode.

Your offer may define a number of allowed days in holiday mode per subscriber, which initializes a counter created at subscriber's activation. Each day your subscriber will spend in holiday mode will decrement this counter. Once it reaches zero, no holiday mode is allowed anymore for this subscriber, and it will automatically go back to its active status.

Schedule holiday

A subscriber cannot switch immediately to tariff holiday, the transition can only happen at the starting date of the next bill cycle. However, when it comes to switching from tariff holiday to active status the change is immediate.

You are able to schedule this mode for a given subscriber for the next bill cycle using the dedicated operation.

A scheduled tariff holiday can be canceled before it even starts by using the cancel tariff holiday operation.

No event is generated when scheduling the tariff holiday, however at the next bill cycle when the subscriber will enter tariff holiday, as for any status change, an enter tariff holiday event will be generated.

Exit tariff holiday

A subscriber exit tariff holiday either:

  • Automatically when the allowed period is expired
  • Manually by calling the exit tariff holiday operation

When a subscriber exit this status an exit tariff holiday event is generated.

Retrieve tariff holiday information

To retrieve tariff holiday information on your subscribers, you can use the retrieve subscriber information operation. This operation will return:

  • holidayScheduled: you can use this information to verify if a tariff holiday has been scheduled
  • holidayRemainingDays: gives you visibility on the remaining tariff holiday period