Versions Compared

Old Version 6

changes.mady.by.user Joseph Ioannou (Unlicensed)

Saved on

compared with

New Version 7

changes.mady.by.user Georgia Kountouri

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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

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

Parameters

Subscriptions Object

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:

subscription_identifier
  • 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 an accounts receivable, and subscription object 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_ACTIVATESTOP_SUBSCRIPTIONSSERVICES: If this mode is set then it is mandatory to specify a subscription identifier 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_SERVICESEXPENSES: 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 and activated and optionally
  • 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_REMOVEAMEND_SERVICES_INSTALLED_ITEMS: 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.

number_of_additional_periods

(optional)

NumberIt determines if the rates should be calculated only for the upcoming period or for additional billing periods. If not specifed then the method will return only the rates for the upcoming period
  • new and/or removed and/or swapped subscription services and/or the set of new/removed subscription installed items

Tip

RATE_AMEND_SERVICES_INSTALLED_ITEMS available from CRM.COM R14.3.0

number_of_additional_periods

(optional)

NumberIt 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

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:

Include Page
V4:subscription_identifier
V4:subscription_identifier

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

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)

Subscription Identifier

The identifier of the existing subscription that should be rated. The allowed subscription identifier fields are the following:

Include Page
V4:subscription_identifierV4:subscription_identifier

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_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

accounts_receivable

(mandatory and applicable on conditions)

Accounts Receivable

RATE_BECOME_SUBSCRIBER

buy_in_advance_request

(mandatory on conditions)

Buy in Advance Request Object

Information related with the accounts receivable that will own the new 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 and for all modes but is mandatory only if the mode is set to RATE_BUY_BECOMEIN_ADVANCE_SUBSCRIBERsubscriptionREQUESTS

new_services_set

(mandatory and applicable on conditions)

Subscriptions ObjectInformation related with the new subscription that will be ratedSet 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_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.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 for all modes but is and mandatory only if the mode is set to RATE_BUY_IN_ADVANCE_REQUESTSnew_services_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 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 if the mode is set to RATE_SWAP_SERVICES.

When the mode is set to RATE_ADDAMEND_SERVICES or RATE_ADD_EXPENSESexisting_servicesINSTALLED_ITEMS, this information is applicable but it is optional.

new_installed_items_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_REMOVEAMEND_SERVICES, RATE_START_SERVICES, RATE_STOP_SERVICES

services_swap_set

(mandatory INSTALLED_ITEMS

Tip

Available from CRM.COM R14.3.0

existing_installed_items_set

(optional and applicable on conditions)

Set of Existing Subscription ServicesInstalled Items

Information with existing new subscription services installed items that will be deactivated 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_SWAPAMEND_SERVICES_INSTALLED_ITEMS

Tip

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

 

Tip

Available from CRM.COM R10.0.0

Referred Parameters Objects Data

...

Include Page
V4:subscription_service_swap_parameter
V4:subscription_service_swap_parameter

Include Page
V4:new_subscription_installed_item_parameter
V4:new_subscription_installed_item_parameter

Include Page
V4:existing_subscription_installed_item_parameter
V4:existing_subscription_installed_item_parameter

Restrictions

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

...