Configure Spendcap
This endpoint allows UK sims on a valid network to have SpendCaps set.
Network Support
| Network | NetworkId |
|---|---|
| Vodafone | 3 |
| Vodafone AT-UK | 200 |
| O2 AT (UK) | 195 |
- SIM status must be "on-hire"
- All SIMs must be:
- On the same network
- On the same account
Request
| Name | Type | Description |
|---|---|---|
serialNumbers | string array | An array of serial numbers corresponding to the SIMs you wish to update |
cap | number | Spendcap amount in pounds serling (£) - greater than 0 |
notifyEmailAddresses | string array | An array of email addresses to notify when a SpendCap triggers |
smsOptOut | boolean | Opt out of the sms notifications that go to a sim |
barsToPersist | array string | A list of Bars that should presist when a SpendCap is lifted |
Valid barsToPersist options
- data
- voice
- international
- dataroaming
- voiceroaming
- premium
- chargeablecalls
Example TopUp
curl --location 'https://api.cellhire.com/api/simSubmission/ConfigureSpendCap' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjRBMDlENTFBMDhEOEUxMTU0OTkyODFDN...' \
--data '{
"serialNumbers": [
"987654321"
],
"cap": 10,
"notifyEmailAddresses": [
"example@test.com"
],
"smsOptOut": true,
"barsToPersist": [
"data",
"voice"
]
}'