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: - FLATRATEQUANTITYBASED
- TIEREDRATEQUANTITYBASED
- FLATRATEMATURITYBASED
- TIEREDRATEMATURITYBASED
- FLATRATEDURATIONBASED
- TIEREDRATEDURATIONBASED
- FLATRATEQUANTITYANDMATURITYBASED
- TIEREDRATEQUANTITYANDMATURITYBASED
- FLATRATE
| Tip |
|---|
FLATRATEMATURITYBASED, FLATRATEQUANTITYANDMATURITYBASED and TIEREDRATEQUANTITYANDMATURITYBASED are available from CRM.COM R14.0.0 |
|
| base_amount | Number | The base rate that is applied if not tiered rates are applied |
| 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 | Tip |
|---|
Available from CRM.COM R12.0.0 |
|
| uot | Sting | 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, although the uot will still be available. |
|
| currency | Currency Object | The currency in which the price plan rate is returned |
| 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. | Tip |
|---|
Available from CRM.COM R14.0.0 |
|
| 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. 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 |
|
| termed_services_tiered_rates_set | Set 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 | Tip |
|---|
Available from CRM.COM R14.0.0 |
| additional_currency_rates | Set 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_tiered_rates | Set of Additional Price Plan Tiered Rates Objects | A list of tiered rates in various currencies for the same product within the specified price plan.
| Tip |
|---|
Available from CRM.COM R14.2.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 |
|---|
| termed_services_tiered_rates_short |
|---|
| termed_services_tiered_rates_short |
|---|
|
| Include Page |
|---|
additional_currency_rates_short | additional_currency_rates_short | | Include Page |
|---|
| additional_currency_tiered_rates_short | additional_currency_tiered_rates_short |
|