...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Available from CRM.COM R9.1.0
| Excerpt |
|---|
This method is used to calculate the rates that will be applied while creating a new subscription or modifying an existing one, before submitting the actual request. The rates calculation can be applied on a single subscription per each call. |
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
mode
(mandatory)
...
It determines if the rate calculation should be applied on a new subscriptions or a modification of an existing subscription. The following options are supported:
...
| Tip |
|---|
Available from CRM.COM R9.1.0 |
| Excerpt |
|---|
This method is used to calculate the rates that will be applied while creating a new subscription or modifying an existing one, before submitting the actual request. The rates calculation can be applied on a single subscription per each call. |
Resource URL
http://host_name/crmapi/rest/$version/subscriptions/calculate_rates
Parameters
Name | Type | Description | ||||||||
token | String | The token retrieved from the login method | ||||||||
mode (mandatory) | String | It determines if the rate calculation should be applied on a new subscriptions or a modification of an existing subscription. The following options are supported:
| ||||||||
number_of_additional_periods (optional) | Number | It determines if the rates should be calculated only for the upcoming period or for additional billing periods. If not specified then the method will return only the rates for the upcoming period | ||||||||
scheduled_date (optional) | Date | The date on which the subscription action is scheduled to be executed, therefore rates will be applied as of this schedueld date.
| ||||||||
subscription_identifier
| ||||||||||
number_of_additional_periods (optional) | Number | It determines if the rates should be calculated only for the upcoming period or for additional billing periods. If not specified then the method will return only the rates for the upcoming period | ||||||||
scheduled_date (optional) | Date | The date on which the subscription action is scheduled to be executed, therefore rates will be applied as of this scheduled date.
| ||||||||
subscription_identifier (mandatory and applicable on conditions) | Subscription Identifier | The identifier of the existing subscription that should be rated. The allowed subscription identifier fields are the following:
Note that this information is applicable and mandatory only if the mode is set to RATE_ACTIVATE_SUBSCRIPTIONS, RATE_ADD_SERVICES, RATE_REMOVE_SERVICES, RATE_SWAP_SERVICES, RATE_START_SERVICES, RATE_STOP_SERVICES, RATE_BUY_IN_ADVANCE_REQUESTS, RATE_ADD_EXPENSES, RATE_BILLING_FREQUENCY_CHANGE, RATE_AMEND_SERVICES_INSTALLED_ITEMS | ||||||||
(mandatory and applicable on conditions) | Accounts Receivable Object | Information related with the accounts receivable that will own the new subscription that will be rated. Note that this information is applicable and mandatory only if the mode is set to RATE_BECOME_SUBSCRIBER | ||||||||
(mandatory and applicable on conditions) | Subscription Identifier | The identifier of the existing subscription that should be rated. The allowed subscription identifier fields are the following: Include Page | | V4:subscription_identifier | V4:subscription_identifierSubscriptions ObjectInformation related with the new subscription that will be rated Note that this information is applicable and mandatory only if the mode is set to RATE_ACTIVATE_SUBSCRIPTIONS, RATE_ADD_SERVICES, RATE_REMOVE_SERVICES, RATE_SWAP_SERVICES, RATE_START_SERVICES, RATE_STOP_SERVICES, RATE_BUY_IN_ADVANCE_REQUESTS, RATE_ADD_EXPENSES | (mandatory and applicable on conditions) | Accounts Receivable Object | Information related with the accounts receivable that will own the new only if the mode is set to RATE_BECOME_SUBSCRIBER | ||
(mandatory on conditions) | Buy in Advance Request Object | Information related with a buy in advance request that might be applicable on the new or existing subscription that will be rated. Note that this information is applicable for all modes but is mandatory only if the mode is set to RATE_BUY_IN_ ADVANCE_REQUESTS
| ||||||||
(mandatory and applicable on conditions) Subscriptions Object | Set of New Subscription Services | Information related with the new subscription services that will be ratedadded and activated on the existing subscription that was specified Note that this information is applicable and mandatory only if the mode is set to RATE_BECOME_SUBSCRIBER | (mandatory on conditions) | Buy in Advance Request Object | Information related with a buy in advance request that might be applicable on the new or existing subscription that will be rated._ADD_SERVICES or RATE_ADD_EXPENSES When the mode is set to RATE_AMEND_SERVICES_INSTALLED_ITEMS, this information is applicable but it is optional. | |||||
(mandatory and applicable on conditions) | Set of Existing Subscription Services | Information with existing subscription services that will be modified on the existing subscription that was specified Note that this information is applicable for all modes but is and mandatory only if the mode is set to RATE_REMOVE_SERVICES, RATE_BUYSTART_INSERVICES, RATE_ADVANCESTOP_REQUESTSnew_servicesSERVICES. When the mode is set to RATE_AMEND_SERVICES_INSTALLED_ITEMS, this information is applicable but it is optional. | ||||||||
(mandatory and applicable on conditions) | Set of New Existing Subscription Services that will be swapped | Information with new existing subscription services that will be added and activated swapped on the existing subscription that was specified Note that this information is applicable and mandatory only if the mode is set to RATE_ADDSWAP_SERVICES or RATE_ADD_EXPENSES. When the mode is set to RATE_AMEND_SERVICES_INSTALLED_ITEMS, this information is applicable but it is optional. | ||||||||
existing_servicesinstalled_items_to_add_set (mandatory optional and applicable on conditions) | Set of Existing New Subscription ServicesInstalled Items | Information with existing new subscription services installed items that will be modified added on the existing subscription that was specified Note that this information is applicable and mandatory optional only if the mode is set to RATE_REMOVE_SERVICES, RATE_START_SERVICES, RATE_STOP_SERVICES.When the mode is set to RATE_AMEND_SERVICES_INSTALLED_ITEMS, this information is applicable but it is optional.services_swap
| ||||||||
(mandatory optional and applicable on conditions) | Set of Existing Subscription Services that will be swappedInstalled Items | Information with existing new subscription services installed items that will be swapped on removed from the existing subscription that was specified Note that this information is applicable and mandatory optional only if the mode is set to RATE_SWAP_SERVICES.When the mode is set to RATE_AMEND_SERVICES_INSTALLED_ITEMS, this information is applicable but it is optional. (optional
| ||||||||
billing_frequency (mandatory and applicable on conditions) | String | Set of New Subscription Installed Items | Information with new subscription installed items that will be added on the subscription that was specified Note that this information is applicable and optional only if The billing frequency of the billing terms that will be created. Billing Frequencies are used to denote how often a subscription should be billed.The supported options are the following: DAILY, WEEKLY, MONTHLY, QUARTERLY, BIANNUAL, ANNUAL, TWOYEARS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 When the mode is set to RATE_AMEND_SERVICES_INSTALLED_ITEMS
| (optional and applicable on conditions) | Set of Existing Subscription Installed Items | Information with new subscription installed items that will be removed from the subscription that was specified Note that , this information is applicable and optional only if but it is optional. When the mode is set to RATE_AMENDBILLING_SERVICES_INSTALLED_ITEMSFREQUENCY_CHANGE, this information is mandatory.
| ||||
udf_string_1 (optional) | String | User Defined Field of type String
| ||||||||
udf_string_2 (optional) | String | User Defined Field of type String
| ||||||||
udf_string_3 (optional) | String | User Defined Field of type String
| ||||||||
udf_string_4 (optional) | String | User Defined Field of type String
| ||||||||
udf_string_5 (optional) | String | User Defined Field of type String
| ||||||||
udf_string_6 (optional) | String | User Defined Field of type String
| ||||||||
udf_string_7 (optional) | String | User Defined Field of type String
| ||||||||
udf_string_8 (optional) | String | User Defined Field of type String
| ||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float
| ||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float
| ||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float
| ||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float
| ||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date
| ||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date
| ||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date
| ||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date
| ||||||||
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
|
Referred Parameters Objects Data
...
| Expand | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
HTTP Method: POST Request: {{server}}/crmapi/rest/v2/subscriptions/calculate_rates Body:
Response:
|
...
| Expand | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
HTTP Method: POST Request: {{server}}/crmapi/rest/v2/subscriptions/calculate_rates Body:
Response:
|
...