Activate On First Use

"Activate on First Use" is only supported on eSIMSmart IOT SIM cards

Flow

Provision a 'Activate On First Use' SIM

To provision a "Activate On First Use" SIM, there are additional fields you must pass to the Provision Endpoint.

You must use a "Activate on First Use" tariff number to provision the SIM(s). If in doubt, please contact your sales representative.

Name	Type	Description	Restrictions
`shutdownThreshold`	`number`	The number of hours, after data usage is first detected, the SIM should be unprovisioned	Range: `1` - `2147483647`
`bundleSizeMb`	`number`	The size of the requested bundle in MB	Range: `1` - `2147483647`

Example Provision

curl --location 'https://api.cellhire.com/api/simSubmission/Provision' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjRBMDlENTFBMDhEOEUxMTU0OTkyODFDN...' \
--data '{
    "stock": [
        {
            "serialNumber": "987654321"
        }
    ],
    "provisioningOrderNumber": 999,
    "tariffNumber": 999,
    "shutdownThreshold": 24,
    "bundleSizeMb": 100
}'

Updating the shutdown threshold

If you wish to change the shutdown threshold of a SIM already provisioned as a "Activate On First Use" SIM, you must make a request to the POST /api/simSubmission/ConfigureThreshold endpoint.

The shutdown threshold is always relative to the date of first data use, regardless of when the threshold was updated.

If the shutdown threshold is updated to be less than the amount of hours since first use, the SIM will be unprovisioned very shortly after it is updated.

Name	Type	Description	Restrictions
`serialNumbers`	`string` array	An array of serial numbers corresponding to the SIMs you wish to update	At least one
`shutdownThreshold`	`number`	The number of hours, after data usage is first detected, the SIM should be unprovisioned	Range: `1` - `2147483647`

Example ConfigureThreshold

curl --location 'https://api.cellhire.com/api/simSubmission/ConfigureThreshold' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjRBMDlENTFBMDhEOEUxMTU0OTkyODFDN...' \
--data '{
    "serialNumbers": [
        "987654321"
    ],
    "shutdownThreshold": 48
}'

Updating the bundle size

If you wish to increase the bundle size of a SIM already provisioned as a "Activate On First Use" SIM, you must make a request to the TopUp Endpoint.

Port Out Porting