Configure Bundle Control

Allows the creation or modification of data bundles.

Currently only available for the Orange (France) LMVNO and Orange (France) M2M networks

Name	Type	Description	Restrictions
`name`	`string`	Name given by User to submission	Optional
`serialNumber`	`string` array	serialNumbers of stock to create/modify bundle	Required
`zone`	`string`	Identifier of bundle roaming zone. Talk to Cellhire representative if you do not know zones available to you	Required
`bundleControlPeriod`	`string`	The frequency the bundle will renew	Options: "oneOff", "daily", "monthly". Some options may not be allowed dependent on network. Required
`sizeMb`	`int`	Size of data bundle in MB	Required
`startDate`	`DateTime`	The date the bundle will be active from	Required. Must be no more than a month prior to current UTC date
`endDate`	`DateTime`	The date the bundle will be stopped. If "oneOff" bundle this will be when bundle stops. If "daily" or "monthly" this will be when bundle stops renewing	Optional
`bundleControlEndAction`	`string`	Action to be taken by network if usage goes above bundle size	Options "cutoff", "throttle" dependent on tariff. Required
`roamingBucketVolumes`	`object` array	Certain networks allow specification of allowances for particuar roaming zones	Optional

Request

curl --location 'https://api.cellhire.com/api/simsubmission/ConfigureBundleControl' \
  -header 'Content-Type: application/json;charset=UTF-8' \
  -header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjRBMDlENTFBMDhEOEUxMTU0OTkyODFDNDdFMjE.....' \
  --data '{
    "name":"Submission Name",
    "serialNumbers":["01234567890"],
    "zone":"europe",
    "bundleControlPeriod":"monthly",
    "sizeMb":2048,
    "startDate":"2024-10-21T09:25:34.524Z",
    "endDate":null, 
    "bundleControlEndAction":"cutoff",
    "roamingBucketVolumes":
    [ 
        {"Name: "BucketName", "AllowanceMB": 1024 }
    ]    
    }'

Bundle Monitor Configure Spendcap