Terminate Cellular Plan
At the end of your program, you might want to give the device to the end-user and stop paying for the SIM plan.
In order to start the end of program process you will have to call the Device-v2 Updatesimstatus webservice.
This API allows partners to initiate the firmware update that lets the end-users take full ownership of the device. Once the SIM plan is terminated, the device will lose its ability to connect over the cellular network and the users can reinstall it via the Withings HealthMate mobile application using Wifi or Bluetooth.
Important: This API is only available for the Pro devices for now. It does not work with the Cellular Hub.
Behavior
When the API is called to update the sim status, the device's sim enters a PENDING_TERMINATION state for 30 days. This is a grace period during which the device can still be used normally. The end date of this period is returned in response to the API call and we recommend you to save it.
During this grace period, developers can still reactivate the cellular network if they change their mind by calling the API again with the STANDBY status.
Important: After the 30 day grace period, the SIM is TERMINATED and cannot be re-activated.
After the SIM get terminated, the device will automatically update within 48 hours and migrate to our consumer firmware. Once the update is complete, the device will display the necessary information on its screen to allow for a seamless setup process.
F.A.Q
How can I know when the included one-year plan ends?
The included one-year plan starts on the first connection of the device to the cellular network
This date can be retrieved from the user-v2.getdevice webservice.
Can I still access the user's data via API after the SIM plan was terminated ?
For the EU cloud, you can still access the data as long as the user continues to use the same account Withings from your program. If the user creates a new account, they can choose to link it back to your application using the OAuth2 Web Flow.
On the US cloud, access to data is not available since our consumer devices utilize the EU cloud.
Can the end-user access his historical data?
On the EU cloud, if the user maintains the same account, they will retain access to their historical data.
On the US cloud, the user won't be able to access historical data.
In either case, partners can provide the user with an export compatible with our import function. This allows the user to retrieve their data on a new account.
How can I check that the update was performed on the device?
The update status can be verified via the Fleet Management tab on your developer dashboard.
Please note that the device needs to connect at least once to our servers after the update for the status to be reflected in the Fleet Management tool.
What is the content of the email that is sent to the user ?
Here is an example of the email that will be sent to the user (+ a picture of the QR code that will be displayed on the screen of the device after the update).