rate_calculation_subscription_parameters
George Rossides (Unlicensed)
Joseph Ioannou (Unlicensed)
Georgia Kountouri
Name | Type | Description | ||||||||||||
type_identifier (mandatory) | Subscription type identifier | The type of the subscription. The allowed subscription type identifier fields are the following:
| ||||||||||||
owned_by_group_identifier (optional) | Group identifier | The group that will be owning the subscription. The allowed group identifier fields are the following:
Deprecated from CRM.COM R18.0.0 | ||||||||||||
owned_by_business_unit_identifier (optional) | Business Unit identifier | The business unit that will be owning the subscription. The allowed business unit identifier fields are the following:
Available from CRM.COM R18.0.0 | ||||||||||||
(mandatory) | Billing Terms Object | The billing terms of the subscription | ||||||||||||
(mandatory) | Set of Subscription Services | The services that will be added on the subscription | ||||||||||||
(optional) | Set of Subscription Installed Items | The installed items that will be added on the subscription |
Referred Parameter Objects Data
Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
billing_term_scheme_identifier (mandatory on conditions) | Billing term scheme identifier | The billing term scheme that will be used on the billing terms. The allowed billing term scheme identifier fields are the following:
The billing_term_scheme_identifier is considered as mandatory up until CRM.COM R13.0.0. From CRM.COM R14.0.0 the identifier becomes mandatory on conditions, which means that it is mandatory only as long as the subscription's type is not of classification Package. Subscription Types of classification Package provide a default Billing Term scheme and the billing_term_scheme_identifier is not applicable in such cases. | |||||||||
price_plan_identifier (mandatory on conditions) | Price plan identifier | The price plan that will be used on the billing terms. The allowed price plan identifier fields are the following:
The price_plan_identifier is considered as mandatory up until CRM.COM R11.2.0. From CRM.COM R11.2.0 the identifier becomes mandatory on conditions, which means that it is mandatory only as long as no default price plan is specified in the Billing Term Scheme From CRM.COM R14.0.0 if the subscription's type is of classification Package which provides a default Price Plan, then that price plan is automatically applied and the price_plan_identifier is not applicable. Deprecated from CRM.COM R15.0.0 | |||||||||
is_auto_renewed (optional) | Boolean | Defines whether the subscription's billing terms will be auto-renewed or not. If not specified, then the subscription's billing terms are marked as auto-renewed. Available from CRM.COM R15.0.0 | |||||||||
billing_cycle_day (mandatory on conditions) | Number | The billing cycle day of the billing terms that will be created. Billing cycle day is used to specify up to which day of the month a subscription should be billed. Applicable and mandatory only when Billing Term Scheme specifies an Anniversary Billing. Mandatory if no automations on how the billing cycle day should be set are defined in the Billing Term Scheme. Either a specific billing cycle day or the fact that the billing cycle day is the last day of each month are mandatory in this case. From CRM.COM R12.0.0, billing_cycle_day becomes mandatory on conditions. In previous releases this is optional. | |||||||||
billing_cycle_last_day_of_month (mandatory on conditions)
| Boolean | Defines whether Anniversary Subscriptions will be billed up until the last day of each month. Applicable only for Anniversary subscriptions and only if no automations on how the billing cycle day is set are defined on the Billing Term Scheme. Either a specific billing cycle day or the fact that the billing cycle day is the last day of each month are mandatory in this case. Available from CRM.COM R12.0.0 | |||||||||
agreement_date (mandatory) | Date | The agreement date of the billing terms that will be created. Billing terms agreement date is used to log the date that the billing terms were agreed and signed by the customer. | |||||||||
billing_frequency (mandatory on conditions) | String | 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 Billing frequency is applicable and mandatory only if the specified billing term scheme is of type "Normal" From CRM.COM R14.0.0 the billing frequency is not mandatory if the subscription's type is of classification Package that provides a default Billing Frequency (it can be amended though). | |||||||||
(optional) | Binding information object | The binding information of the billing term that will be created. Binding information is used to determine if a customer is contractually committed to receive services from the service provider for a fixed period of time. | |||||||||
concurrent_usage_based_pricing (mandatory on conditions) | Concurrent usage based pricing object | Concurrent usage based pricing is used to apply pricing and billing rules based on the subscription's concurrent usage which is agreed between the customer and the company providing those service. Concurrent usage based pricing is applicable and mandatory only if it is supported by the billing term schemes | |||||||||
period_billed_in_advance (mandatory on conditions) | float | The period that the specified service will be billed in advance. Applicable and mandatory only for prepaid and pre-rated billing term scheme. If nothing is specified then the default value will be provided Icon Available from CRM.COM R15.0.0 | |||||||||
period_billed_in_advance_uot (mandatory on conditions) | String | The unit of time for the period that the specified service will be billed in advance. Applicable and mandatory only for prepaid and pre-rated billing term scheme. The supported values are DAYS, WEEKS or MONTHS. If nothing is specified then the default value will be provided Icon Available from CRM.COM R15.0.0 |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
binding_period (mandatory) | String | The binding period which can be one of the following: WEEK, MONTH, QUARTER, BIANNUAL, ANNUAL, TWOYEARS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 From CRM.COM R14.0.0 the binding period becomes mandatory on conditions, which means that it is mandatory only as long as the subscription's type is not of classification Package which provides a default Binding period (it can be amended though). From CRM.COM R18.0.0 the binding period is mandatory (Package subscription types are deprecated) |
start_date (mandatory on conditions) | Date | The date that the binding period starts. From CRM.COM R14.0.0 onwards start_date is mandatory only if no configuration exists in Subscription Billing Term Definitions related to Binding Start Date Automation. From CRM.COM R18.0.0 the binding period is mandatory (Package subscription types are deprecated) |
Name | Type | Description |
|---|---|---|
concurrent_usage (mandatory) | Number | Defines the concurrent usage of services which will be billed based on the specified billing terms Deprecated from CRM.COM R15.0.0 |
rate_percentage (mandatory) | Number | Defines the rate percentage that should be applied on all services which will be billed based on the specified billing terms Deprecated from CRM.COM R15.0.0 |
number_of_installed_items (mandatory on conditions) | Number | The agreed number of installed items that will be concurrently consuming the related subscription's services. Applicable and mandatory if concurrent usage billing method is set to "based on number of installed items". Available from CRM.COM R15.0.0 |
concurrent_usage_billing_method (mandatory) | String | Defines how the subscription will be billed for the agreed concurrent usage. Available options are:
If not specified, then the billing method is considered as "based on number of installed items". Available from CRM.COM R15.0.0 |
Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| service_identifier (mandatory) | Service identifier | The identifier of the service. Only products classified as services are retrieved. The allowed service identifier fields are the following:
From CRM.COM R14.0.0 onwards, if the Subscription's Type is of classification Package then any Services added on the Subscription are considered as Additional Services. | ||||||||||||
period_billed_in_advance (mandatory on conditions) | Integer | The period that the specified service will be billed in advance. Applicable and mandatory only for prepaid and pre-rated services. If nothing is specified then the default value will be provided Available from CRM.COM R14.0.0 Deprecated from CRM.COM R15.0.0 | ||||||||||||
period_billed_in_advance_uot (mandatory on conditions) | String | The unit of time for the period that the specified service will be billed in advance. Applicable and mandatory only for prepaid and pre-rated services. The supported values are DAYS, WEEKS or MONTHS. Available from CRM.COM R14.0.0 Deprecated from CRM.COM R15.0.0 | ||||||||||||
udf_string_1 (optional) | String | User Defined Field of type String Available from CRM.COM R14.3.0 | ||||||||||||
udf_string_2 (optional) | String | User Defined Field of type String Available from CRM.COM R14.3.0 | ||||||||||||
udf_string_3 (optional) | String | User Defined Field of type String Available from CRM.COM R14.3.0 | ||||||||||||
udf_string_4 (optional) | String | User Defined Field of type String Available from CRM.COM R14.3.0 | ||||||||||||
udf_string_5 (optional) | String | User Defined Field of type String Available from CRM.COM R14.3.0 | ||||||||||||
udf_string_6 (optional) | String | User Defined Field of type String Available from CRM.COM R14.3.0 | ||||||||||||
udf_string_7 (optional) | String | User Defined Field of type String Available from CRM.COM R14.3.0 | ||||||||||||
udf_string_8 (optional) | String | User Defined Field of type String Available from CRM.COM R14.3.0 | ||||||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float Available from CRM.COM R14.3.0 | ||||||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float Available from CRM.COM R14.3.0 | ||||||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float Available from CRM.COM R14.3.0 | ||||||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float Available from CRM.COM R14.3.0 | ||||||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date Available from CRM.COM R14.3.0 | ||||||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date Available from CRM.COM R14.3.0 | ||||||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date Available from CRM.COM R14.3.0 | ||||||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date Available from CRM.COM R14.3.0 | ||||||||||||
(optional) | Set of subscription service distribution objects | The distribution of the services that will be added on the subscription Deprecated from CRM.COM R15.0.0 | ||||||||||||
(mandatory on conditions) | Set of subscription service components objects | The service components that should be composing the specified service. This information is available and mandatory if the specified service is a flexible product bundle
|
Referred Parameter Objects Data
Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
provisioning_distributor_identifier (mandatory) | Provisioning distributor identifier | The identifier of the provisioning distributor. The allowed provisioning distributor identifier fields are the following:
|
Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| service_identifier (mandatory) | Service identifier | The identifier of the service. Only products classified as services, which are also included in the product components of the related flexible product bundle are retrieved. The allowed service identifier fields are the following:
|
Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| installed_item_identifier (mandatory) | Installed item identifier | The identifier of the installed item. The allowed installed item identifier fields are the following:
| ||||||||||||
udf_string_1 (optional) | String | User Defined Field of type String Available from CRM.COM R14.3.0 | ||||||||||||
udf_string_2 (optional) | String | User Defined Field of type String Available from CRM.COM R14.3.0 | ||||||||||||
udf_string_3 (optional) | String | User Defined Field of type String Available from CRM.COM R14.3.0 | ||||||||||||
udf_string_4 (optional) | String | User Defined Field of type String Available from CRM.COM R14.3.0 | ||||||||||||
udf_string_5 (optional) | String | User Defined Field of type String Available from CRM.COM R14.3.0 | ||||||||||||
udf_string_6 (optional) | String | User Defined Field of type String Available from CRM.COM R14.3.0 | ||||||||||||
udf_string_7 (optional) | String | User Defined Field of type String Available from CRM.COM R14.3.0 | ||||||||||||
udf_string_8 (optional) | String | User Defined Field of type String Available from CRM.COM R14.3.0 | ||||||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float Available from CRM.COM R14.3.0 | ||||||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float Available from CRM.COM R14.3.0 | ||||||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float Available from CRM.COM R14.3.0 | ||||||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float Available from CRM.COM R14.3.0 | ||||||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date Available from CRM.COM R14.3.0 | ||||||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date Available from CRM.COM R14.3.0 | ||||||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date Available from CRM.COM R14.3.0 | ||||||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date Available from CRM.COM R14.3.0 | ||||||||||||
installed_items_distribution_set (optional) | Set of subscription installed item distribution objects | The distribution of the installed items that will be added on the subscription Deprecated from CRM.COM R15.0.0 |
Referred Parameter Objects Data
Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
provisioning_distributor_identifier (mandatory) | Provisioning distributor identifier | The identifier of the provisioning distributor. The allowed provisioning distributor identifier fields are the following:
|