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

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

base_amountNumberThe base rate that is applied if not tiered rates are applied
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

Available from CRM.COM R12.0.0

uotSting

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
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 ObjectsA list of tiered rates related to the specified product. This information is applicable only for tiered price plan rate models.

Referred Objects Response Data