Available from CRM.COM R15.0.0
This method returns the available price plan rates included in a price plan either for a specific product or for all products by providing one of the billable entities (semi-optional parameters) the rates are requested for between subscription, job or accounts receivable (for physical good sales). Multiple price plan rates might be retrieved by each call.
Resource URL
Parameters
Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
token | String | The token retrieved from the login method | ||||||||||||
subscription_identifier (semi-optional) | String | The identifier of the subscription for which rates should be returned as a result. The allowed subscription identifier fields are the following:
| ||||||||||||
job_identifier (semi-optional) | String | The identifier of the job for which rates should be returned as a result. The allowed job identifier fields are the following:
| ||||||||||||
accounts_receivable_identifier (semi-optional) | String | The identifier of the accounts receivable for which a sale is made against (i.e. quick sale) and for which rates should be returned as a result. The allowed accounts receivable identifier fields are the following:
| ||||||||||||
product_identifier (optional) | String | The identifier of the product whose price plan rates should be returned as a result. The allowed product identifier fields are the following:
If a single product is defined then only rates for the specific product will be retrieved.
| ||||||||||||
date (optional) | Date | The date for which you want to see the available rates for. | ||||||||||||
from_date (optional) | The date from which the termed service is rated for. Applicable only for termed services | |||||||||||||
to_date (optional) | The date up to which the termed service is to be rated. Applicable only for termed services | |||||||||||||
quantity (optional) | The quantity of the physical goods or termed services. Applicable only for physical goods and termed services (multiple viewing points) | |||||||||||||
duration (optional) | The duration of the one time service. Applicable only for one time services | |||||||||||||
usage_amount (optional) | The usage amount of the usage service. Applicable only for usage services | |||||||||||||
usage_zone (optional) | The usage zone the required usage service belongs to. Applicable only for usage services | |||||||||||||
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:
| ||||||||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call | ||||||||||||
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 | ||||||||||||
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
Examples