GET price_plans/get_available_rates
- Former user (Deleted)
- Georgia Kountouri
- George Rossides (Unlicensed)
Available from CRM.COM R9.1.0
This method returns the available base and any conditional price plan rates included in a price plan either for a specific product or for all products. Multiple price plan rates might be retrieved by each call. Price plan rates are retrieved by providing one and only one of the semi-optional parameters
- A specific subscription type: If specified then the process will retrieved all effective price plans which are allowed by the billing term schemes which are allowed by the specified subscription type
- A specific job type: If specified then the process will retrieved all effective price plans which are allowed by the billing term schemes which are allowed by the specified job type
- A specific billing term scheme: If specified then the process will retrieved all effective price plans which are allowed by the specified billing term scheme
- A specific price plan: If specified then the process will retrieved only that specific price plan
and optionally one of the following or both of the optional parameters:
- A specific product: If specified then the process will retrieve only the rates for that specific product. If not specified then the process will retrieve rates of any products
- A specific rate model: If specified then the process will retrieve only the rates that are following the specific rate model. If not specified then the process will retrieve rates following any rate mode
Resource URL
Parameters
Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
token | String | The token retrieved from the login method | ||||||||||||
subscription_type_identifier (semi-optional) | Subscription Type Identifier | The identifier of the subscription type whose allowed billing term schemes include effective price plans whose rates should be returned as a result. The allowed subscription type identifier fields are the following:
| ||||||||||||
job_type_identifier (semi-optional) | Job Type Identifier | The identifier of the job type whose allowed billing term schemes include effective price plans whose rates should be returned as a result. The allowed job type identifier fields are the following:
| ||||||||||||
billing_term_scheme_identifier (semi-optional) | Billing Term Scheme Identifier | The identifier of the billing term scheme which includes effective price plans whose rates should be returned as a result. The allowed billing term scheme identifier fields are the following:
| ||||||||||||
price_plan_identifier (semi-optional) | Price Plan Identifier | The identifier of the price plan whose rates should be returned as a result. The allowed price plan identifier fields are the following:
| ||||||||||||
product_identifier (optional) | Product Identifier | The identifier of the product whose price plan rates should be returned as a result. The allowed product identifier fields are the following:
| ||||||||||||
rate_model (optional) | String | The price plan rate model that determines how the calculation will be performed in order to retrieve a product's final price. If specified then price plan rates that are following the specific rate model will be retrieved, otherwise price plan rates of any model will be retrieved. The allowed price plan rate models are the following:
FLATRATEMATURITYBASED, FLATRATEQUANTITYANDMATURITYBASED and TIEREDRATEQUANTITYANDMATURITYBASED are available from CRM.COM R14.0.0 | ||||||||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call Available from CRM.COM R13.0.0 | ||||||||||||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number Available from CRM.COM R13.0.0 | ||||||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned. |
Response Data
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:
FLATRATEMATURITYBASED, FLATRATEQUANTITYANDMATURITYBASED and TIEREDRATEQUANTITYANDMATURITYBASED are available from CRM.COM R14.0.0 From CRM.COM R15.0.0 the following values are available:
From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED |
| 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 Available from CRM.COM R12.0.0 Not Available from CRM.COM R15.0.0 |
| 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:
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 |
| currency | Currency Object | The currency in which the price plan rate is returned Available from CRM.COM R14.2.0 |
| 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. Available from CRM.COM R15.0.0 |
| 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. Available from CRM.COM R15.0.0 |
| 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. Available from CRM.COM R15.0.0 |
| price_plan_period | Price Plan Period object | The period for which the rate is applicable for Available from CRM.COM R15.0.0 |
| 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. 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. 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_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 Available from CRM.COM R14.0.0 |
| 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 Available from CRM.COM R15.0.0 |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": [
{
"effective_starting_from": null,
"product_bundle": {
"id": "29274AE54AEAD3E51BB07AAC3B3DEBC1",
"description": null,
"code": "Viasat Gold",
"alternative_code": "VG"
},
"base_amount": 3,
"tiered_rates_set": [
{
"tiered_amount": 2,
"tier_level": "2",
"tier_rate_to_option": "SPECIFIC_NUMBER",
"tier_rate_from": 4,
"tier_rate_to": 7
},
{
"tiered_amount": 3,
"tier_level": "1",
"tier_rate_to_option": "SPECIFIC_NUMBER",
"tier_rate_from": 1,
"tier_rate_to": 3
}
],
"rate_model": "TIEREDRATEQUANTITYBASED",
"uot": "DAYS",
"code": "5662",
"price_plan": {
"effective_date": "2016-04-18T00:00:00",
"type": "BASE",
"id": "0410E96E76274F07B9F1F3B1446A2C4A",
"name": "Movies L",
"description": null,
"code": "Movies L",
"expiration_date": null
},
"product": {
"product_type": {
"service_type": "TERMED",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "600438B64B0F05AB3D020C902674949F",
"name": "Subscription services",
"description": "Subscription services",
"alternative_code": "SS"
},
"id": "4D55A6EC2FF25A44B9945B88940AF1A0",
"description": "Sports 2",
"code": "Sports 2",
"alternative_code": "S2"
}
}
]
}
HTTP Method: GET
Request:
Response:
{
"data": [
{
"product": {
"code": "Smartcard",
"product_type": {
"meter_reading_type": null,
"service_type": null,
"used_for_provisioning": true,
"alternative_code": "S",
"udr_type": null,
"composition_method": "FLAT",
"name": "SMARTCARD",
"description": "SMARTCARD",
"id": "D6BE0209EC0149989A89972CE889DF8B",
"classification": "PHYSICALGOODS",
"physical_good_type": "TRACEABLE"
},
"alternative_code": "S",
"description": "Smartcard",
"id": "4F656ED5DAC44168B0805227881202CD",
"priority_level": null
},
"code": "9865",
"price_plan": {
"code": "Combination",
"name": "Combination",
"effective_date": "2018-01-18T00:00:00",
"description": null,
"id": "7BFBFA30A6804BB28D6F4708BD7DB97A",
"type": "BASE",
"expiration_date": null
},
"base_amount": 1,
"rate_model": "FLATRATEQUANTITYBASED",
"effective_starting_from": null,
"uot": null,
"time_period": null,
"product_bundle": null,
"tiered_rates_set": [
{
"tier_rate_to": 10,
"tier_rate_from": 1,
"tier_level": "1",
"tier_rate_to_option": "SPECIFIC_NUMBER",
"tiered_amount": 1.2
},
{
"tier_rate_to": null,
"tier_rate_from": 11,
"tier_level": "2",
"tiered_amount": 1.3
}
]
},
{
"product": {
"code": "Bronze",
"product_type": {
"meter_reading_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"alternative_code": "Main Packages",
"udr_type": null,
"composition_method": "FLAT",
"name": "Main Packages",
"description": null,
"id": "E186E293AAAB49EE86A729540A4287FE",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "B",
"description": "Bronze",
"id": "F50CC52934BD4F119B6E18E215A4FC55",
"priority_level": null
},
"code": "9866",
"termed_services_tiered_rates_set": [
{
"amount": 5,
"level": "3",
"to_maturity_period": 7,
"to_quantity": 8,
"from_maturity_period": 5,
"from_quantity": 4
},
{
"amount": 1.1,
"level": "1",
"to_maturity_period": 2,
"to_quantity": 5,
"from_maturity_period": 1,
"from_quantity": 3
},
{
"amount": 1.4,
"level": "1",
"to_maturity_period": 2,
"to_quantity": 2,
"from_maturity_period": 1,
"from_quantity": 1
},
{
"amount": 3,
"level": "2",
"to_maturity_period": 4,
"to_quantity": 3,
"from_maturity_period": 3,
"from_quantity": 2
}
],
"price_plan": {
"code": "Combination",
"name": "Combination",
"effective_date": "2018-01-18T00:00:00",
"description": null,
"id": "7BFBFA30A6804BB28D6F4708BD7DB97A",
"type": "BASE",
"expiration_date": null
},
"base_amount": 1,
"rate_model": "FLATRATEQUANTITYANDMATURITYBASED",
"effective_starting_from": null,
"uot": "DAYS",
"time_period": {
"time_period_uot": 1,
"time_period_value": "DAYS"
},
"product_bundle": null
},
{
"product": {
"code": "Silver",
"product_type": {
"meter_reading_type": null,
"service_type": "TERMED",
"used_for_provisioning": true,
"alternative_code": "Main Packages",
"udr_type": null,
"composition_method": "FLAT",
"name": "Main Packages",
"description": null,
"id": "E186E293AAAB49EE86A729540A4287FE",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "SLV",
"description": "SILVER",
"id": "AF390B58BCE646D485EAC39D44C2C81C",
"priority_level": null
},
"code": "9867",
"termed_services_tiered_rates_set": [
{
"amount": 2,
"level": "2",
"to_maturity_period": null,
"to_quantity": 5,
"from_maturity_period": null,
"from_quantity": 4
},
{
"amount": 1,
"level": "1",
"to_maturity_period": null,
"to_quantity": 2,
"from_maturity_period": null,
"from_quantity": 1
}
],
"price_plan": {
"code": "Combination",
"name": "Combination",
"effective_date": "2018-01-18T00:00:00",
"description": null,
"id": "7BFBFA30A6804BB28D6F4708BD7DB97A",
"type": "BASE",
"expiration_date": null
},
"base_amount": 2,
"rate_model": "FLATRATEQUANTITYANDMATURITYBASED",
"effective_starting_from": null,
"uot": "DAYS",
"time_period": {
"time_period_uot": 1,
"time_period_value": "DAYS"
},
"product_bundle": null
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
}