usage_service_tiered_rates_update_parameters

 usage_service_tiered_rates parameter object data
NameType Description
action

(mandatory)

String

Defines if a new or existing information will be updated.The supported values are the following:

ADD, UPDATE, REMOVE

tier_rate_identifier

(mandatory and applicable only on update or remove)

Usage Service Tier Rate Identifier

The identifier of the tier rate that will be updated or removed. This is applicable only if the specified action is set to UPDATE or REMOVE. The allowed usage service tier rate identifier fields are the following:

Name

Type

Description

id

(mandatory)

String

The ID of the usage service tier rate

rate

(mandatory on add, optional on update, not applicable on remove)

FloatThe rate of the usage service tiered rate

minimum_usage

(semi-optional on add, optional on update, not applicable on remove)

FloatThe minimum usage of the service that should be applied in order for the specified rate to be applicable

maximum_usage

(semi-optional on add, optional on update, not applicable on remove)

FloatThe maximum usage of the service that should be applied in order for the specified rate to be applicable

usage_method_identifier

(semi-optional on add, optional on update, not applicable on remove)

Usage Detail Record Usage Method Identifier

The usage method that should be used in order for the specified rate to be applicable. The allowed usage method identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the usage detail record usage_method

name

(semi-optional)

String

The name of the usage detail record usage_method

alternative_code

(semi-optional)

String

The alternative code of  the usage detail record usage_method

device_identifier

(semi-optional on add, optional on update, not applicable on remove)

Usage Detail Record Device IdentifierThe device that should be used in order for the specified rate to be applicable. The allowed device identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the usage detail record device

name

(semi-optional)

String

The name of the usage detail record device

alternative_code

(semi-optional)

String

The alternative code of  the usage detail record device

source_category_identifier

(semi-optional on add, optional on update, not applicable on remove)

Usage Detail Record Source Category IdentifierThe source category that should be used in order for the specified rate to be applicable. The allowed source category identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the usage detail record source category

name

(semi-optional)

String

The name of the usage detail record source category

code

(semi-optional)

String

The code of  the usage detail record source category

destination_category_identifier

(semi-optional on add, optional on update, not applicable on remove)

Usage Detail Record Destination Category IdentifierThe destination category that should be used in order for the specified rate to be applicable. The allowed destination category identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the usage detail record destination category

name

(semi-optional)

String

The name of the usage detail record destination category

code

(semi-optional)

String

The code of  the usage detail record destination category

usage_start_time

(semi-optional on add, optional on update, not applicable on remove)

Hour / Minute ObjectThe usage start time during which the specified rate is applicable

usage_end_time

(semi-optional on add, optional on update, not applicable on remove)

Hour / Minute ObjectThe usage end time during which the specified rate is applicable

Referred Parameter Objects

 hour / minute parameter object data

Name

Type

Description

hour

(mandatory)

Number

The hour value

minute

(mandatory)

Number

The minute value