Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...


Name

Type

Description

codeStringThe code of the retrieved price plan rate
rate_modelString

The rate model of the retrieved price plan rate. Available values are:

  • FLATRATEQUANTITYBASED
  • TIEREDRATEQUANTITYBASED
  • FLATRATEMATURITYBASED
  • TIEREDRATEMATURITYBASED
  • FLATRATEDURATIONBASED
  • TIEREDRATEDURATIONBASED
  • FLATRATEQUANTITYANDMATURITYBASED
  • TIEREDRATEQUANTITYANDMATURITYBASED
  • FLATRATE
Tip

FLATRATEMATURITYBASED, FLATRATEQUANTITYANDMATURITYBASED and TIEREDRATEQUANTITYANDMATURITYBASED are available from CRM.COM R14.0.0


From CRM.COM R15.0.0 the following values are available:

  • QUANTITYBASED
  • QUANTITYANDPERIODBASED
  • BILLABLEPERIODBASED (FLATRATEMATURITYBASED)
  • DURATIONBASED
  • FLATFEEBASED (FLATRATE)
  • USAGEBASED (NEW)


Tip

From CRM.COM R17.0.0QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED


base_amountNumberThe base rate that is applied if not tiered rates are applied
base_rate_applied_perString

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

  • Period
  • Period & Item

Applicable only for Period & Quantity Based

effective_starting_fromSting

The date option that determines when a recurring charges will become active. Applicable only for termed services. The applicable values are: BINDINGSTARTDATE, SERVICEEFFECTIVEDATE, AGREEMENTDATE and LATESTRATEDUPTODATE

Tip

Available from CRM.COM R12.0.0


Tip

Not Available from CRM.COM R15.0.0


uot
Sting
String

The unit of time that can be used to measure time. This is mandatory information only for termed services.The applicable values are:

  • SECONDS
  • MINUTES
  • HOUR
  • DAY
  • WEEK
  • MONTH
  • YEAR
Tip

From CRM.COM R14.0.0 the time period object should be used for termed services, although the uot will still be available for duration based rate models


currencyCurrency Object

The currency in which the price plan rate is returned

Tip

Available from CRM.COM R14.2.0


uomString

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

Tip

Available from CRM.COM R15.0.0


aggregate_tiered_ratesBoolean

If the tiered rates of a model are defined as aggregate the final price is the sum of tiered rates, according to the duration or usage of the service or quantity of the product. 

Tip

Available from CRM.COM R15.0.0


tiered_level_start_at_last_rated_to_dateBoolean

Used to define that each tier level should start from the last rated to date applicable only for Billable Period Based rate model and Period & Quantity Based.

Tip

Available from CRM.COM R15.0.0


price_plan_periodPrice Plan Period object

The period for which the rate is applicable for

Tip

Available from CRM.COM R15.0.0


time_periodTime Period Object

 The period and unit of time used to calculate the rates for termed services. This is applicable only on termed services rates. Only days, weeks, months and years are applicable for termed services rates.

The period and unit of time used to calculate the rates for termed services. This is applicable only on termed services rates. Only days, weeks, months and years are applicable for termed services rates.

Tip

Available from CRM.COM R14.0.0


price_planPrice Plan ObjectThe base price plan related with the retrieved price plan. This information is available only if the retrieved price plan is a conditional price plan
productProduct ObjectThe physical good or service whose price plan rate is returned as a result.
product_bundleProduct ObjectThe product bundle related with the selected product whose price plan rate is returned as a result.. This information is applicable only if the specified product is used as a product component belonging to a product having a type classified as flexible bundle product.
tiered_rates_setSet of Tiered Rates Objects

A list of tiered rates related to the specified product.

This information is applicable only for tiered price plan rate models.

Tip

From CRM.COM R14.0.0 the termed_services_rates_set should be used for termed services. The tiered_rates_set will still be available but it will not be applicable for termed services following the FLATRATEQUANTITYANDMATURITYBASED and TIEREDRATEQUANTITYANDMATURITYBASED rate models

From CRM.COM R15.0.0 applicable for termed services following the BILLABLEPERIODBASED rate model


termed_services_tiered_rates_setSet of Termed Services Tiered Rates Objects

A list of tiered rates related to

the specified

termed service

. This information is applicable only for tiered price plan rate models defined for termed services

of Matrutity & Quantity Rate model.

Applicable for termed services following the QUANTITYANDMATURITYBASED rate model

Tip

Available from CRM.COM R14.0.0

additional


usage_
currency_ratesSet of Additional Price Plan Rates Objects

A list of base rates in various currencies for the same product within the specified price plan.

Tip

Available from CRM.COM R14.2.0

additional_currency_
services_tiered_rates_setSet of
Additional Price Plan
Usage Services Tiered Rates Objects

A list of tiered rates

in various currencies for the same product within

related to the specified

price plan.

usage service.

Applicable for usage services

Tip

Available from CRM.COM

R14

R15.

2

0.0


Anchor
price plan rates referred objects
price plan rates referred objects
Referred Objects Response Data

Include Page
currency_short
currency_short

Include Page
time_period_short
time_period_short

Include Page
price_plan_period_short
price_plan_period_short

Include Page
price_plan_short
price_plan_short

Include Page
product_short
product_short

...

Include Page
termed_services_tiered_rates_short
termed_services_tiered_rates_short

Include Page
additional_currency_rates_shortadditional_currency_rates_short
Include Page
additional_currencyusage_services_tiered_rates_shortadditional
usage_currencyservices_tiered_rates_short