Organization

Assign a ratezone inclusive volume to an organization

Assigns a pre-configured ratezone inclusive volume to the specified organization. This can be done in self-service as well as for direct child organizations. Only postpaid customers can assign inclusive volumes in self-service, while parent organizations can assign inclusive volumes for both postpaid and prepaid child organizations. The inclusive volume is 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 organization can be chosen. Enterprise organizations are only allowed to upgrade to a higher inclusive volume if there is already one active in the current month. The request body is optional. All fields have default values and detailed constraints are specified in the schema below.

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

Configure the inclusive volume billing period and pooling behavior. All fields are optional and will use default values if omitted.
start_datestringOptionalformat: "date-time"

The first day of the month when this inclusive volume assignment becomes active. Defaults to the first day of the current month. Times are normalized to midnight UTC (times in input are stripped). Must be the current month or a future month.

end_datestring or nullOptionalformat: "date-time"

The last day of the month when this inclusive volume assignment expires. Defaults to null (indefinite duration). When specified, must be the last day of a calendar month. Times are normalized to 23:59:59 UTC (times in input are stripped). Must be on or after the start_date.

pooledbooleanOptionalDefaults to true
Whether the inclusive volume is shared across all devices or tracked individually. - `true` (default): Data consumption is pooled. All devices share the monthly volume limit. - `false`: Each device receives its own quota proportional to the total volume.

Response

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

Errors