Page Comparison

...

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

title	usage_service_catalog_usage_services parameter object data

Name

Type

Description

action

(mandatory)

String

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

ADD, UPDATE, REMOVE

usage_service_catalog_identifier

(mandatory and applicable only on update or remove)

Usage Service Catalog Usage Service Identifier

The usage service catalog usage service entry that will be updated or removed. This is applicable only if the specified action is set to update or remove. The allowed usage service catalog usage service identifier fields are the following:

Include Page

	usage_service_catalog_usage_service_identifier
	usage_service_catalog_usage_service_identifier

base_rate

(mandatory on conditions and applicable only on add or update, not applicable on remove)

Float

usage

service catalog definitions.

Tip
Deprecated from CRM.COM R15.0.0

usage

_service_identifier

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

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

Note that this information is applicable only if the specified action is set to add

product_family_identifier

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

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 on add, not applicable on update or remove)

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 on add, optional on update, not applicable on remove)

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 on add, optional on update, not applicable on remove)

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 and applicable only on add or update, not applicable on remove)

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 on add, optional on update, not applicable on remove)

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 on add and update, not applicable on remove)

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 on add and update, not applicable on remove)

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 on add, optional on update, not applicable on remove)

String

User Defined Field of type String

udf_string_2

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

String

User Defined Field of type String

udf_string_3

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

String

User Defined Field of type String

udf_string_4

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

String

User Defined Field of type String

udf_string_5

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

String

User Defined Field of type String

udf_string_6

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

String

User Defined Field of type String

udf_string_7

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

String

User Defined Field of type String

udf_string_8

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

String

User Defined Field of type String

udf_float_1

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

Float

User Defined Field of type Float

udf_float_2

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

Float

User Defined Field of type Float

udf_float_3

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

Float

User Defined Field of type Float

udf_float_4

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

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

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

Date

User Defined Field of type Date

udf_date_3

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

Date

User Defined Field of type Date

udf_date_4

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

Date

User Defined Field of type Date

usage_service

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

Product Object

The 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.

Note that this information is applicable only if the specified action is set to add

tiered_rates_set

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

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

Include Page

	Web API - Updating Sets
	Web API - Updating Sets

Tip
Deprecated from CRM.COM R15.0.0

Versions Compared

Old Version 12

New Version Current

Key