global_rate_parameters

global_rate object parameter data

Name

Type

Description

base_amount

(mandatory)

Number

The base rate that is applied if not tiered rates are applied

rate_model

(mandatory on conditions)

String

The rate model of the retrieved price plan rate which is applicable only if the product type is of a product classification/service type Termed Service.

Available values are:

QUANTITYANDMATURITYBASED
BILLABLEPERIODBASED

For any of the other product classification/type the rate model is automatically set. The applicable values are as follows:

QUANTITYBASED
QUANTITYANDMATURITYBASED
BILLABLEPERIODBASED
DURATIONBASED
FLATFEEBASED (FLATRATE)
USAGEBASED (NEW)

base_rate_applied_per

(mandatory on conditions)

String

Determines whether the amount provided is per period or period and quantity. The following options are available

Period
Period & Item

Mandatory and applicable only for 'Maturity & Quantity' Based rate model

uot

(mandatory on conditions)

String

The unit of time used for one-time services rates. The following options are available

SECONDS
MINUTES
HOUR
DAY
WEEK
MONTH
YEAR

Mandatory and applicable only for one-time services (Duration rate model)

uom

(mandatory on conditions)

String

Unit of Measurement represents the unit of measurement that can be used in the system in order to measure usage UOM are configurable.

Mandatory and applicable only for usage services (Usage based rate model)

time_period

(mandatory on conditions)

Time Period Object

The period and unit of time used for termed services rates.

Mandatory and applicable only on termed services rates.

Referred Objects Data

time period parameter object data

Name

Type

Description

time_period_value

(mandatory)

Number

The time period value

time_period_uot

(mandatory)

String

The time period unit of time

The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS