Assign a ratezone inclusive volume to an organization

Assign a pre-configured ratezone inclusive volume to the specified organisation. This can be done in self-service as well as for direct child organisations. Only postpaid customers can assign inclusive volumes in self-service, while parent organisations can assign inclusive volumes for both postpaid and prepaid child organisations. 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. Only inclusive volumes of ratezones belonging to the tariffs assigned to the selected organisation can be chosen. Enterprise organisations are only allowed to upgrade to a higher inclusive volume if there is already one active in the current month. 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. The request body for this entrypoint is optional. Default values are: * `start_date`: First day of the current month * `end_date`: `null` (Inclusive volume will run indefinitely until the end date is set.) * `pooled`: `true`

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

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

Path parameters

org_id_or_mystringRequiredformat: "^(my)|(\d+)$"Defaults to my

Numerical ID of an Organization or the string my to use the currently authorized organisation

inclusive_volume_iddoubleRequired

Numerical ID of a ratezone inclusive volume. Can be retrieved using GET /api/v1/tariff/{tariff_id}/ratezone/{ratezone_id}/inclusive_volume.

Request

This endpoint expects an object.
start_datestringOptionalformat: "date-time"
end_datestringOptionalformat: "date-time"
pooledbooleanOptional

Response

Created
idinteger or null
start_datestring or nullformat: "date-time"
end_datestring or nullformat: "date-time"
pooledboolean or null

Errors