...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Name | Type | Description | ||
|---|---|---|---|---|
| code | String | The code of the retrieved price plan rate | ||
| rate_model | String | The rate model of the retrieved price plan rate. Available values are:
|
From CRM.COM R15.0.0 the following values are available:
|
| ||
| base_amount | Number | The base rate that is applied if not tiered rates are applied |
| base_rate_applied_per | String | Determines whether the amount provided is per period or period and quantity. The following options are available
Applicable only for |
Period & Quantity Based | ||||||
| effective_starting_from | Sting | 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
| ||||
| uot | String | The unit of time that can be used to measure time. This is mandatory information only for termed services.The applicable values are:
| ||||
| currency | Currency Object | The currency in which the price plan rate is returned
| ||||
| uom | String | Unit of Measurement represents the unit of measurement that can be used in the system in order to measure usage UOM are configurable.
| ||||
| aggregate_tiered_rates | Boolean | 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.
| ||||
| tiered_level_start_at_last_rated_to_date | Boolean | 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.
| ||||
| price_plan_period | Price Plan Period object | The period for which the rate is applicable for
| ||
| time_period | Time 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.
| ||
| price_plan | Price Plan Object | The base price plan related with the retrieved price plan. This information is available only if the retrieved price plan is a conditional price plan | ||
| product | Product Object | The physical good or service whose price plan rate is returned as a result. | ||
| product_bundle | Product Object | The 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_set | Set of Tiered Rates Objects | A list of tiered rates related to the specified product.
| ||
| termed_services_tiered_rates_set | Set of Termed Services Tiered Rates Objects | A list of tiered rates related to termed service of Matrutity & Quantity Rate model. Applicable for termed services following the QUANTITYANDMATURITYBASED rate model
| ||
| usage_services_tiered_rates_set | Set of Usage Services Tiered Rates Objects | A list of tiered rates related to the specified usage service. Applicable for usage services
|
Referred Objects Response DataAnchor price plan rates referred objects price plan rates referred objects
...