POST subscriptions/calculate_rates

Available from CRM.COM R9.1.0

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:

RATE_BECOME_SUBSCRIBER: If this mode is set then it is mandatory to specify an accounts receivable, and subscription object and optionally a buy in advance request object. All the other fields are not applicable.
RATE_ACTIVATE_SUBSCRIPTIONS: If this mode is set then it is mandatory to specify a subscription identifier and optionally a buy in advance request object. All the other fields are not applicable.
RATE_ADD_SERVICES: If this mode is set then it is mandatory to specify a subscription identifier, the set of new subscription services that will be added and activated and optionally a buy in advance request object. All the other fields are not applicable.
RATE_REMOVE_SERVICES: If this mode is set then it is mandatory to specify a subscription identifier, the set of existing subscription services that will be removed and optionally a buy in advance request object. All the other fields are not applicable.
RATE_SWAP_SERVICES: If this mode is set then it is mandatory to specify a subscription identifier, the set of existing subscription service swaps and optionally a buy in advance request object. All the other fields are not applicable.
RATE_START_SERVICES: If this mode is set then it is mandatory to specify a subscription identifier, the set of existing subscription services that will be started and optionally a buy in advance request object. All the other fields are not applicable.
RATE_STOP_SERVICES: If this mode is set then it is mandatory to specify a subscription identifier, the set of existing subscription services that will be stopped and optionally a buy in advance request object. All the other fields are not applicable.
RATE_ADD_EXPENSES: If this mode is set then it is mandatory to specify a subscription identifier, and the set of new subscription services (expenses) that will be added
RATE_BUY_IN_ADVANCE_REQUESTS: If this mode is set then it is mandatory to specify a subscription identifier and a buy in advance request object. All the other fields are not applicable.
RATE_AMEND_SERVICES_INSTALLED_ITEMS: If this mode is set then it is mandatory to specify a subscription identifier, the set of new and/or removed and/or swapped subscription services and/or the set of new/removed subscription installed items
RATE_BILLING_FREQUENCY_CHANGE: If this mode is set then it is mandatory to specify billing frequency.

RATE_AMEND_SERVICES_INSTALLED_ITEMS available from CRM.COM R14.3.0

RATE_BUY_IN_ADVANCE_REQUESTS deprecated in CRM.COM R18.0.0

RATE_BILLING_FREQUENCY_CHANGE available from CRM.COM R14.28.0

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.

Available from CRM.COM R14.5.0

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:

Name

Type

Description

id

(semi-optional)

String

The ID of subscription

number

(semi-optional)

String

The number of subscription

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

accounts_receivable

(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

subscription

(mandatory and applicable on conditions)

Subscriptions Object

Information 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_BECOME_SUBSCRIBER

buy_in_advance_request

(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

Deprecated from CRM.COM R18.0.0

new_services_set

(mandatory and applicable on conditions)

Set of New Subscription Services

Information with new services that will be added 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_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.

existing_services_set

(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 and mandatory 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_set

(mandatory and applicable on conditions)

Set of Existing Subscription Services that will be swapped

Information with existing subscription services that will be swapped on the existing subscription that was specified

Note that this information is applicable and mandatory 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.

installed_items_to_add_set

(optional and applicable on conditions)

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 mode is set to RATE_AMEND_SERVICES_INSTALLED_ITEMS

Available from CRM.COM R14.3.0

installed_items_to_remove_set

(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 the mode is set to RATE_AMEND_SERVICES_INSTALLED_ITEMS

Available from CRM.COM R14.3.0

billing_frequency

(mandatory and applicable 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

When the mode is set to RATE_AMEND_SERVICES_INSTALLED_ITEMS, this information is applicable but it is optional.

When the mode is set to RATE_BILLING_FREQUENCY_CHANGE, this information is mandatory.

Available from CRM.COM R14.28.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

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

Available from CRM.COM R10.0.0

Referred Parameters Objects Data

accounts_receivable_parameter object data

Name

Type

Description

classification_identifier

(mandatory)

Accounts receivable classification identifier

The accounts receivable classification identifier. The allowed classification identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the classification

name

(semi-optional)

String

The name of the classification

alternative_code

(semi-optional)

String

The alternative code of the classification

billing_address

(optional)

Billing address Object

The accounts receivable billing address

presentment_preferences_set

(optional)

Set of Presentment Preferences Object

The presentment preferences of the accounts receivable.

payment_preferences_set

(optional)

Set of Payment Preferences Object

The payment preferences of the retrieved accounts receivable.

Referred Parameter Objects Data

billing_address object parameter data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing address will be used. In the case of an existing address then it also defines if the existing address should be updated or not. The supported values are the following:

NEW, EXISTING, EXISTINGUPDATED

type

(mandatory on conditions)

String

The contact information address that should be set as the billing address address. This is applicable and mandatory only if the action is set to EXISTING or EXISTINGUPDATED. The supported options are the following:

HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

address

(mandatory on conditions)

Address object

The address to be created (if action is set to NEW) or updated (if action is set to EXISTINGUPDATED). This is applicable and mandatory only if the action is set to NEW or EXISTINGUPDATED.

Referred Objects Response Data

address parameter object data

From R14.2.0, the following object is applicable for CRM.COM Address Format

Name

Type

Description

type

(mandatory)

String

The type of the address which can be added

HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

is_primary

(mandatory on conditions)

Boolean

Weather the address is the primary one

Applicable from CRM.COM R16.1.0 onwards

postal_code

(optional)

String

The postal code of the address

street_name

(mandatory on conditions)

String

The street name of the address

street_number

(optional)

String

The street number of the address

floor

(optional)

Integer

The floor of the address

apartment_number

(optional)

String

The apartment number of the address

area

(optional)

String

The area of the address

town_city

(optional)

String

The town/city of the address

district

(optional)

String

The district of the address

municipality

(optional)

String

The municipality of the address

country_identifier

(optional)

Country identifier

The country of the address. The allowed country identifier fields are the following:

Name	Type	Description
id (semi-optional)	String	The ID of the country
name (semi-optional)	String	The name of the country
alternative_code (semi-optional)	String	The alternative code of the retrieved country
two_character_code (semi-optional)	String	The two character code of the retrieved country
three_character_code (semi-optional)	String	The three character code of the retrieved country

po_box

(optional)

String

The PO box of the address

po_box_postal_code

(optional)

String

The PO box postal code of the address

care_of

(optional)

String

The care of person of the address

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_string_9

(optional)

String

User Defined Field of type String

udf_string_10

(optional)

String

User Defined Field of type String

udf_string_11

(optional)

String

User Defined Field of type String

udf_string_12

(optional)

String

User Defined Field of type String

udf_string_13

(optional)

String

User Defined Field of type String

udf_string_14

(optional)

String

User Defined Field of type String

udf_string_15

(optional)

String

User Defined Field of type String

udf_string_16

(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

From R14.2.0, the following object is applicable for International Address Format

Name

Type

Description

type

(mandatory)

String

The type of the address which can be added

HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

postal_code

(optional)

String

The postal code of the address

town_city

(optional)

String

The town/city of the address

country_identifier

(optional)

Country identifier

The country of the address. The allowed country identifier fields are the following:

Name	Type	Description
id (semi-optional)	String	The ID of the country
name (semi-optional)	String	The name of the country
alternative_code (semi-optional)	String	The alternative code of the retrieved country
two_character_code (semi-optional)	String	The two character code of the retrieved country
three_character_code (semi-optional)	String	The three character code of the retrieved country

address_line_1

(mandatory)

String

The address line 1

address_line_2

(optional)

String

The address line 2

state_province_county

(optional)

String

The state or province or county of the address.

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_string_9

(optional)

String

User Defined Field of type String

udf_string_10

(optional)

String

User Defined Field of type String

udf_string_11

(optional)

String

User Defined Field of type String

udf_string_12

(optional)

String

User Defined Field of type String

udf_string_13

(optional)

String

User Defined Field of type String

udf_string_14

(optional)

String

User Defined Field of type String

udf_string_15

(optional)

String

User Defined Field of type String

udf_string_16

(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

accounts_receivable_presentment_preference object parameter data

Name

Type

Description

presentment_preference_identifier

(mandatory)

Identifier

The identifier of the presentment preference to be added on account presentment preference object. The allowed presentment preference identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of presentment preference

name

(semi-optional)

String

The name of presentment preference

alternative_code

(semi-optional)

String

The alternative code of presentment preference

accounts_receivable_payment_preference object parameter data

Name

Type

Description

payment_preference_identifier

(mandatory)

Identifier

The identifier of the payment preference to be added on account payment preference object. The allowed payment preference identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of payment preference

name

(semi-optional)

String

The name of payment preference

alternative_code

(semi-optional)

String

The alternative code of payment preference

subscription_parameter object data

Name

Type

Description

type_identifier

(mandatory)

Subscription type identifier

The type of the subscription. The allowed subscription type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the subscription type

name

(semi-optional)

String

The name of the subscription type

alternative_code

(semi-optional)

String

The alternative code of the subscription type

owned_by_group_identifier

(optional)

Group identifier

The group that will be owning the subscription. The allowed group identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the group

name

(semi-optional)

String

The code of the group

alternative_code

(semi-optional)

String

The alternative code of the group

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the business unit

name

(semi-optional)

String

The code of the business unit

code

(semi-optional)

String

The code of the business unit

Available from CRM.COM R18.0.0

billing_terms

(mandatory)

Billing Terms Object

The billing terms of the subscription

services_set

(mandatory)

Set of Subscription Services

The services that will be added on the subscription

installed_items_set

(optional)

Set of Subscription Installed Items

The installed items that will be added on the subscription

Referred Parameter Objects Data

billing_terms object parameter 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:

Name

Type

Description

id

(semi-optional)

String

The ID of the billing term scheme

code

(semi-optional)

String

The code of the billing term scheme

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the price plan

code

(semi-optional)

String

The code of the price plan

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).

binding_information

(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

binding_information object parameter 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)

concurrent_usage_based_pricing object parameter data

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: BASED_ON_NUMBER_OF_INSTALLED_ITEMS BASED_ON_MAXIMUM_CAPACITY BASED_ON_ACTUAL_CAPACITY If not specified, then the billing method is considered as "based on number of installed items". Available from CRM.COM R15.0.0

new subscription service object parameter data

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of the product

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

services_distribution_set

(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

components_set

(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

subscription_service_distribution object parameter 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

id

(semi-optional)

String

The ID of the provisioning distributor

name

(semi-optional)

String

The name of the provisioning distributor

alternative_code

(semi-optional)

String

The alternative code of the provisioning distributor

subscription_service_component object parameter data

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

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of the product

subscription_installed_item object parameter data

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the installed item

serial_number

(semi-optional)

String

The serial number of the installed item

alternative_code

(semi-optional)

String

The alternative code of a installed item

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

subscription_installed_item_distribution object parameter 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

id

(semi-optional)

String

The ID of the provisioning distributor

name

(semi-optional)

String

The name of the provisioning distributor

alternative_code

(semi-optional)

String

The alternative code of the provisioning distributor

buy_in_advance_parameters object data

Name	Type	Description
duration (mandatory)	Number	The duration that is requested to be bough in advance
unit_of_time (mandatory)	String	The unit of time that measures the specified duration. The supported values are DAYS, WEEKS, MONTHS or YEARS
billing_effective_date (optional)	Date	The billing effective date of the buy in advance request, that determines the earliest date that the request can be picked up by the billing engine. If not specified then it is automatically set to the date that the request is submitted

new subscription service object parameter data

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of the product

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

services_distribution_set

(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

components_set

(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

subscription_service_distribution object parameter 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

id

(semi-optional)

String

The ID of the provisioning distributor

name

(semi-optional)

String

The name of the provisioning distributor

alternative_code

(semi-optional)

String

The alternative code of the provisioning distributor

subscription_service_component object parameter data

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

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of the product

existing subscription service object parameter data

Name

Type

Description

subscription_service_id

(semi-optional)

String

The ID of the subscription service

service_identifier

(semi-optional)

Service identifier

The identifier of the service related with the subscription service that belongs to the subscription specified in the parameters. Only products classified as services are retrieved. The allowed service identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of the product

subscription_service_swap object parameter data

Name

Type

Description

from_service

(mandatory)

Existing subscription service object

The subscription service that should be removed from the subscription

to_service

(mandatory)

New subscription service object

The service that should be added on the subscription

Referred Parameter Objects Data

existing subscription service object parameter data

Name

Type

Description

subscription_service_id

(semi-optional)

String

The ID of the subscription service

service_identifier

(semi-optional)

Service identifier

The identifier of the service related with the subscription service that belongs to the subscription specified in the parameters. Only products classified as services are retrieved. The allowed service identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of the product

new_subscription_service object parameter data

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of the product

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.

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

components_set

(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

subscription_service_component object parameter data

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

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of the product

subscription_installed_item object parameter data

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the installed item

serial_number

(semi-optional)

String

The serial number of the installed item

alternative_code

(semi-optional)

String

The alternative code of a installed item

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

subscription_installed_item_distribution object parameter 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

id

(semi-optional)

String

The ID of the provisioning distributor

name

(semi-optional)

String

The name of the provisioning distributor

alternative_code

(semi-optional)

String

The alternative code of the provisioning distributor

existing_subscription_installed_item object parameter data

Name

Type

Description

subscription_installed_item_id

(semi-optional)

String

The ID of the subscription installed item

installed_item_identifier

(semi-optional)

Installed item identifier

The identifier of the installed item which is related with the subscription installed item belonging to the subscription specified in the parameters. The allowed installed item identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the installed item

serial_number

(semi-optional)

String

The serial number of the installed item

alternative_code

(semi-optional)

String

The alternative code of a installed item

Restrictions

It is mandatory to specify one of the semi-optional parameters. More than one of those parameters are allowed to be specified.

Response Data

Name	Type	Description
upcoming_rates	Calculated Upcoming Rates Object	The upcoming rates are the rates that will be charged for the next (upcoming) billing period, which in some cases might be prorated
additional_period_rates_set	Set of Calculated Additional Period Rates Object	The rates for the additional billing periods that will occur after the upcoming billing period. The number of periods that are included are based on the specified number of additional periods specified in the parameters

Referred Objects Response Data

calculated upcoming rates object response data

Name	Type	Description
total_amount	Number	The total amount that the subscription is rated for
total_amount_of_parent	Number	The total rated amount that should be paid by the parent account. Applicable only if the subscription is owned by a member account Available from CRM.COM R13.0.0 Starting from CRM.COM R14.0.0, this parameter will be* deprecated*
total_amount_of_member	Number	The total rated amount that should be paid by the member account. Applicable only if the subscription is owned by a member account Available from CRM.COM R13.0.0 Starting from CRM.COM R14.0.0, this parameter will be* deprecated*
total_discount_amount	Number	The total discount amount
total_discount_amount_of_parent	Number	The discount amount that the parent account will benefit from. Applicable only if the subscription is owned by a member account Available from CRM.COM R13.0.0 Starting from CRM.COM R14.0.0, this parameter will be* deprecated*
total_discount_amount_of_member	Number	The discount amount that will be given to the member account. Applicable only if the subscription is owned by a member account Available from CRM.COM R13.0.0 Starting from CRM.COM R14.0.0, this parameter will be* deprecated*
total_vat_amount	Number	The total VAT amount Available from CRM.COM R12.0.0
total_vat_amount_of_parent	Number	The VAT amount that the parent account will be rated for. Applicable only if the subscription is owned by a member account Available from CRM.COM R13.0.0 Starting from CRM.COM R14.0.0, this parameter will be* deprecated*
total_vat_amount_of_member	Number	The VAT amount that the member account will be rated for. Applicable only if the subscription is owned by a member account Available from CRM.COM R13.0.0 Starting from CRM.COM R14.0.0, this parameter will be* deprecated*
total_tax_amount	Number	The total Tax amount Available from CRM.COM R12.0.0
total_tax_amount_of_parent	Number	The Tax amount that the parent account will be rated for. Applicable only if the subscription is owned by a member account Available from CRM.COM R13.0.0 Starting from CRM.COM R14.0.0, this parameter will be* deprecated*
total_tax_amount_of_member	Number	The Tax amount that the member account will be rated for. Applicable only if the subscription is owned by a member account Available from CRM.COM R13.0.0 Starting from CRM.COM R14.0.0, this parameter will be* deprecated*
amount_to_be_paid	Number	The amount that should be paid at the time of calculation, considering any balance brought forward
amount_to_be_paid_by_parent		The amount that should be paid at the time of calculation by the parent account. Applicable only if the account owner is a member of a group which is funded by another account Available from CRM.COM R13.0.0 Starting from CRM.COM R14.0.0, this parameter will be* deprecated*
amount_to_be_paid_by_member	Number	The amount that should be paid at the time of calculation by the member account. Applicable only if the account owner is a member of a group Available from CRM.COM R13.0.0 Starting from CRM.COM R14.0.0, this parameter will be* deprecated*
as_of_date	Date	The date that was used to rate the services
currency	Currency Object	The currency related to the rates Available from CRM.COM R10.0.0
service_rates_set	Set of upcoming service rates	The rates that are applied on each subscription service

Referred Objects Response Data

currency object response data

Name	Type	Description
id	String	The ID of the retrieved currency
code	String	The code of the retrieved currency
prefix_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

service rates object response data

Name	Type	Description
total_amount	Number	The total amount that the service is rated for
total_discount_amount	Number	The total discount amount
from_date	Date	The start of the time period, that the calculated rate will be covering, for the specific service
to_date	Date	The end of the time period, that the calculated rate will be covering, for the specific service
currency	Currency Object	The currency related to the rates Available from CRM.COM R10.0.0
service	Product Object	The service that was rated

Referred Objects Response Data

currency object response data

Name	Type	Description
id	String	The ID of the retrieved currency
code	String	The code of the retrieved currency
prefix_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

product object response data

Name	Type	Description
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

global rate object response data

Name	Type	Description
id	String	The ID of the retrieved rate
rate_model	String	The price plan rate model which can be one of the following: QUANTITYBASED QUANTITYANDPERIODBASED BILLABLEPERIODBASED DURATIONBASED FLATFEEBASED USAGEBASED From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED
global_base_amount	Number	The base price of the product in the Global Price Plan
base_rate_applied_per	String	The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between Period Period_Item
uot	String	The 'UOT' applicable for the rate Seconds Minute Hour Day Week Month Year Available for one-time services
time_period	Time Period Object	The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.
uom	String	The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

calculated additional period rates object response data

Name	Type	Description
period_number	Number	The number of the period
total_amount	Number	The total amount that the subscription is rated for
total_discount_amount	Number	The total discount amount
total_vat_amount	Number	The total VAT amount Available from CRM.COM R12.0.0
total_tax_amount	Number	The total Tax amount Available from CRM.COM R12.0.0
as_of_date	Date	The date that was used to rate the services
currency	Currency Object	The currency related to the rates Available from CRM.COM R10.0.0
service_rates_set	Set of recurring service rates	The rates that are applied on each subscription service

Referred Objects Response Data

currency object response data

Name	Type	Description
id	String	The ID of the retrieved currency
code	String	The code of the retrieved currency
prefix_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

service rates object response data

Name	Type	Description
total_amount	Number	The total amount that the service is rated for
total_discount_amount	Number	The total discount amount
currency	Currency Object	The currency related to the rates Available from CRM.COM R10.0.0
time_period	Time Period Object	The period (number & UOT) that the calculated rate will be covering, for the specific service
service	Product Object	The service that was rated

Referred Objects Response Data

currency object response data

Name	Type	Description
id	String	The ID of the retrieved currency
code	String	The code of the retrieved currency
prefix_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

product object response data

Name	Type	Description
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

global rate object response data

Name	Type	Description
id	String	The ID of the retrieved rate
rate_model	String	The price plan rate model which can be one of the following: QUANTITYBASED QUANTITYANDPERIODBASED BILLABLEPERIODBASED DURATIONBASED FLATFEEBASED USAGEBASED From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED
global_base_amount	Number	The base price of the product in the Global Price Plan
base_rate_applied_per	String	The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between Period Period_Item
uot	String	The 'UOT' applicable for the rate Seconds Minute Hour Day Week Month Year Available for one-time services
time_period	Time Period Object	The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.
uom	String	The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

Examples

Example 1

HTTP Method: POST

Request:

{{server}}/crmapi/rest/v2/subscriptions/calculate_rates

Body:

{
"token":"{{token}}",
"number_of_additional_periods":3,
"mode":"RATE_BECOME_SUBSCRIBER",
    "accounts_receivable":{"classification_identifier":{"name":"VIP Customer"}},
    "subscription":{
                      "type_identifier":{
                               "name":"Normal"
                               },
                     "billing_terms":{
                        "billing_term_scheme_identifier":{
                            "code":"MPBTS"
                        },
                        "price_plan_identifier":{
                            "code":"BPP0614"
                        },
                        "agreement_date":"2016-05-22T15:00:00",
                         "concurrent_usage_based_pricing":
                          {
                                "concurrent_usage":1,
                                "rate_percentage":100
                          }
                    },
                        "services_set":
                        [
                            {
                                "service_identifier":{
                                    "code":"Bronze"
                                }
                            },
                            {
                                "service_identifier":{
                                    "code":"Gold Extra"
                                }
                            }
                        ]
                    },
    "buy_in_advance_request":{
                        "duration":2,
                        "unit_of_time": "MONTHS",
                        "billing_effective_date": "2016-05-15T00:00:00"
                      }
}

Response:

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "upcoming_rates": {
      "total_amount": 27,
      "as_of_date": "Mon May 23 16:18:19 EEST 2016",
      "amount_to_be_paid": 27,
      "total_discount_amount": 0,
      "service_rates_set": [
        {
          "to_date": "Fri Jul 22 00:00:00 EEST 2016",
          "from_date": "Sun May 22 00:00:00 EEST 2016",
          "total_amount": 9,
          "service": {
            "product_type": {
              "service_type": "TERMED",
              "physical_good_type": null,
              "used_for_provisioning": true,
              "classification": "SERVICES",
              "composition_method": "FLAT",
              "id": "BC954969D3172372D498D3BB2BA590A0",
              "name": "Subscription Packages",
              "description": "Subscription main packages",
              "alternative_code": "SP"
            },
            "id": "A15149563AC0E7D3613F3C1B6E2EE4F5",
            "description": "Bronze\r\n",
            "code": "Bronze",
            "alternative_code": "S"
          },
          "total_discount_amount": 1
        },
        {
          "to_date": "Fri Jul 22 00:00:00 EEST 2016",
          "from_date": "Sun May 22 00:00:00 EEST 2016",
          "total_amount": 18,
          "service": {
            "product_type": {
              "service_type": "TERMED",
              "physical_good_type": null,
              "used_for_provisioning": true,
              "classification": "SERVICES",
              "composition_method": "FLAT",
              "id": "BC954969D3172372D498D3BB2BA590A0",
              "name": "Subscription Packages",
              "description": "Subscription main packages",
              "alternative_code": "SP"
            },
            "id": "A7FA7B53161B4D82A118E7734E576CDA",
            "description": null,
            "code": "Gold Extra",
            "alternative_code": "GE"
          },
          "total_discount_amount": 2
        }
      ]
    },
    "additional_period_rates_set": [
      {
        "total_amount": 0,
        "period_number": 1,
        "as_of_date": "Thu Jun 23 16:18:19 EEST 2016",
        "total_discount_amount": 0,
        "service_rates_set": null
      },
      {
        "total_amount": 0,
        "period_number": 2,
        "as_of_date": "Fri Jun 24 16:18:19 EEST 2016",
        "total_discount_amount": 0,
        "service_rates_set": null
      },
      {
        "total_amount": 0,
        "period_number": 3,
        "as_of_date": "Sat Jun 25 16:18:19 EEST 2016",
        "total_discount_amount": 0,
        "service_rates_set": null
      }
    ]
  }
}

Example 2

HTTP Method: POST

Request:

{{server}}/crmapi/rest/v2/subscriptions/calculate_rates

Body:

{
    "token":"{{token}}",
    "mode":"RATE_ACTIVATE_SUBSCRIPTIONS",
    "subscription_identifier":{"number":"S0000008563"}
}

Response:

{
  "data": {
    "upcoming_rates": {
      "total_amount_of_parent": 550,
      "total_vat_amount_of_member": 4.22,
      "total_vat_amount_of_parent": 102.07,
      "as_of_date": "2017-05-01T12:02:18",
      "total_discount_amount_of_member": 0,
      "total_tax_amount_of_parent": 51.53,
      "total_amount_of_member": 21.08,
      "total_tax_amount_of_member": 0.49,
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": "€",
        "decimal_part_name": null,
        "code": "EUR",
        "integer_part_name": null,
        "id": "2"
      },
      "service_rates_set": [
        {
          "from_date": "2017-04-06T00:00:00",
          "to_date": "2017-06-01T00:00:00",
          "total_amount": 550,
          "service": {
            "code": "Gold",
            "product_type": {
              "service_type": "TERMED",
              "used_for_provisioning": true,
              "alternative_code": "Main Packages",
              "composition_method": "FLAT",
              "name": "Main Packages",
              "description": null,
              "id": "E186E293AAAB49EE86A729540A4287FE",
              "classification": "SERVICES",
              "physical_good_type": null
            },
            "alternative_code": "G",
            "description": "Gold",
            "id": "D1EB074DFD904E54A0C67CAB9DC7E010"
          },
          "total_discount_amount": 0
        },
        {
          "from_date": "2017-04-06T00:00:00",
          "to_date": "2017-06-01T00:00:00",
          "total_amount": 21.08,
          "service": {
            "code": "Movies 1",
            "product_type": {
              "service_type": "TERMED",
              "used_for_provisioning": true,
              "alternative_code": "AS",
              "composition_method": "FLAT",
              "name": "Additional Services",
              "description": null,
              "id": "C8321F0BCA8A4051857BC35CEEE41555",
              "classification": "SERVICES",
              "physical_good_type": null
            },
            "alternative_code": "M1",
            "description": "Movies 1",
            "id": "571C10876AF840088372A94A14D0A02C"
          },
          "total_discount_amount": 0
        }
      ],
      "amount_to_be_paid_of_member": 21.08,
      "total_discount_amount_of_parent": 0
    }
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}