API ReferenceBilling

Assign an inclusive volume to an organisation

Assign an inclusive volume for a given ratezone to the specified organisation. This can only be done for direct child organisations and not in self-service. The inclusive volume will be charged and calculated against traffic charges accordingly in every bill that is refreshed from that point on. Inclusive volume is counted per device on a monthly basis, the data can be pooled as well or be treated per individual device. The `start_date` and `end_date` of the inclusive volume denote the billing period which this volume applies to, where the start must be always the first day of a month, and the end the last day. Times of the fields will be stripped. Inclusive volumes can only be assigned for the current or a future month. When setting the `excess_traffic` rate, a new custom ratezone rate will be created for the selected organisation. The same date logic as on the inclusive volume will be applied. If `multi` is set to false and the user tries to configure another inclusive volume in the same ratezone, any active or future inclusive volumes in that ratezone will be expired. If set to true, it will be possible to configure multiple active inclusive volumes per ratezones.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the POST request to /api/v1/authenticate.

Path parameters

org_iddoubleRequired
Numerical ID of an organization

Request

This endpoint expects an object.
currencyobjectRequired
The currency of the volume, must be the same than the organisations currency
ratedoubleRequired
the monthly rate that this volume is charged at. must be a positive floating point number
volumedoubleRequired
the monthly volume that each device can consume in the ratezone with no additional cost. must be a positive floting point number
ratezoneobjectRequired
The ratezone where the devices can consume traffic of this in
pooledbooleanOptional
Denotes if the inclusive volume should be pooled across devices or not
start_datestringOptionalformat: "^\d{4}-\d{2}-\d{2}$"
end_datestringOptionalformat: "^\d{4}-\d{2}-\d{2}$"
excess_trafficdoubleOptional
Excess traffic rate that will be applied if the inclusive volume is depleted
multibooleanOptional
If set to true, it will be possible to configure multiple inclusive volumes in the same ratezone. Otherwise the expiration logic will be applied.

Response

Response to a POST that results in a creation, usually will return a Location header pointing to the location of the new resource

Errors