Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...


The base rate of the usage service catalog usage service. This information is mandatory unless a default rate, related with the type of the specified usage service, was defined in the active
Expand
titleusage_service_catalog_usage_services parameter object data


NameType Description

base_rate

(mandatory on conditions)
Float

usage

service catalog definitions.
Tip

Deprecated from CRM.COM R15.0.0

usage

_service_identifier

(semi-optional)

Usage Service Identifier

The identifier of the related usage service. This is applicable only when adding existing products in a usage service catalog. Only products classified as usage services can be added in a usage service catalog. This information is mandatory unless a usage service (object) is specified. The allowed usage service identifier fields are the following:

Include Page
product_identifier
product_identifier

product_family_identifier

(semi-optional)

Product Family Identifier

The identifier of the related product family of the usage service

The allowed product family identifier fields are the following

Include Page
product_family_identifier
product_family_identifier

Tip

Available from CRM.COM R17.0.0


product_category_identifier

(semi-optional)

Product Category Identifier

The identifier of the related product category of the usage service

The allowed product category identifier fields are the following

Include Page
product_category_identifier
product_category_identifier

Tip

Available from CRM.COM R17.0.0


start_date

(optional)

String

The date and time during which the provisioning of the usage service catalog usage service will start

Tip

Deprecated from CRM.COM R17.0.0


end_date

(optional)

String

The date and time during which the provisioning of the usage service catalog usage service will end

Tip

Deprecated from CRM.COM R17.0.0


base_rate

(mandatory on conditions)

Float

The base rate of the usage service catalog usage service. This information is mandatory unless a default rate, related with the type of the specified usage service, was defined in the active usage service catalog definitions.

Tip

Deprecated from CRM.COM R15.0.0


provisioning_id

(mandatory and applicable on conditions)

String

The ID used to provision the specified usage service. This information is applicable and mandatory only if the related usage service is classified as a provisioning service

Tip

Deprecated from CRM.COM R15.0.0


pre_rated

(optional)

Boolean

It defines if the usage service catalog usage service is a pre-rated service or not. It the value is true then it means that the service is pre-rated. It the value is false then it means that the service is post-rated

Note that if the service is pre-rated then the base rate and tier rates are not applicable nor mandatory

Tip

Available from CRM.COM R12.0.0

Tip

Deprecated from CRM.COM R15.0.0


apply_additional_discount

(optional)

Boolean

It defines if additional discount will be applicable on the pre-rated usage service. This option is applicable only if the usage service is classified as pre-rated

Tip

Available from CRM.COM R13.0.0

tip

Deprecated from CRM.COM R15.0.0


udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

usage_service

(semi-optional)

Product ObjectThe related usage service. This is applicable only when adding new products in a usage service catalog. Only products classified as usage services can be added in a usage service catalog. This information is mandatory unless a usage service identifier is specified.

tiered_rates_set

(optional)

Set of Usage Service Tiered Rates Objects

The tiered rates related with the usage service catalog usage service, which are different than the specified base rate, and are applied upon meeting a set of conditions

Tip

Deprecated from CRM.COM R15.0.0


Anchor
usage service catalog usage service create referred objects
usage service catalog usage service create referred objects
Referred Parameter Objects Data

Include Page
product_parameters
product_parameters

Include Page
usage_service_tiered_rates_parameters
usage_service_tiered_rates_parameters

...