Page Comparison

...

Tip
Available from CRM.COM R13.0.0

Excerpt
This method amends a subscription by adding and distributing new services or physical goods, removing existing services or physical goods or changing the distribution of existing services or physical goods. Only one subscription can be amended through each call but multiple services or physical goods can be amended through each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifier

(semi-optional)

Subscription identifier

The subscription to be modified. The allowed subscription identifier fields are the following:

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier

The accounts receivable identifier that can be used to perform the subscription modification. The allowed accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier_post
	V4:accounts_receivable_identifier_post

Note
The ability to use the accounts_receivable_identifier instead of the subscription_identifier is applicable only when the specified Accounts Receivable owns only one Subscription

action_type_identifier

(optional)

Subscription action type identifier

The action type that should be used. The allowed subscription action type identifier fields are the following:

Include Page

	V4:subscription_action_type_identifier
	V4:subscription_action_type_identifier

Tip
Deprecated from CRM.COM R15.0.0

sub_action_type_identifier

(optional)

Subscription sub action type identifier

The sub action type that should be used. The allowed subscription sub action type identifier fields are the following:

Include Page

	V4:subscription_sub_action_type_identifier
	V4:subscription_sub_action_type_identifier

Tip
Deprecated from CRM.COM R15.0.0

classification_identifier

(optional)

Subscription Action Classification Identifier

The subscription action's classification. The allowed subscription action classification identifier fields are the following:

Include Page

	V4:subscription_action_classification_identifier
	V4:subscription_action_classification_identifier

Tip
Available from CRM.COM

...

R18.0.0

...

This method amends a subscription by adding and distributing new services or physical goods, removing existing services or physical goods or changing the distribution of existing services or physical goods. Only one subscription can be amended through each call but multiple services or physical goods can be amended through each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifier

(semi-optional)

Subscription identifierThe subscription to be modified. The allowed subscription

payment_gateway_card_identifier

(optional)

Payment Gateway Card Identifier

The payment gateway card that will be used to post a payment against the accounts receivable of the subscription. Applicable and required only for Subscriptions following the "Pay before bill" payment model. The applicable payment gateway card identifier fields are the following:

Include Page

	V4:payment_gateway_card_identifier
	V4:payment_gateway_card_identifier

Tip
Available from CRM.COM R14.3.0

performed_by_user_identifier

(optional)

User identifier

The user that actually performed the action. The allowed user identifier fields are the following:

Include Page

	V4:

subscription

user_identifier
	V4:

subscription

user_identifier

accounts

performed_by_

receivable

unit_identifier

(

semi-

optional)

Accounts Receivable

Unit Identifier

The

accounts receivable identifier that can be used to perform the subscription modification

unit that performed the action. The allowed

accounts receivable

unit identifier fields are the following:

Include Page

	V4:

accounts_receivable

unit_identifier

_post


	V4:

accounts

unit_

receivable_identifier_post

Note
The ability to use the accounts_receivable_identifier instead of the subscription_identifier is applicable only when the specified Accounts Receivable owns only one Subscription

action_type

identifier

Tip

Available from CRM.COM R14.0.0

Deprecated from CRM.COM R18.0.0

performed_by_business_unit_identifier

(optional)

Subscription action type identifier

Business Unit Identifier

The

action type that should be used

business unit that performed the action. The allowed

subscription action type

business unit identifier fields are the following:

Include Page

	V4:business_unit_identifier
	V4:

subscription_action_type_identifierV4:subscription_action_type_identifiersub_action_type_identifier

business_unit_identifier

Tip
Available from CRM.COM R18.0.0

transaction_reference_number

(optional)

String

The transaction reference number for the subscription action that is performed. The transaction reference number is unique against already submitted subscription actions.

performed_on

(optional)

Subscription sub action type identifier

Date

The

sub action type that should be used. The allowed subscription sub action type identifier fields are the following: Include PageV4:subscription_sub_action_type_identifierV4:subscription_sub_action_type_identifiertransaction_reference_numberperformed_by_user_identifier

date that the action was actually performed

billing_effective_date

(optional)

Date

Determines when the subscription services that are affected by the subscription action should be billed by the billing engine.

billable_period_start_date

(optional)

String

The transaction reference number for the subscription action that is performed. The transaction reference number is unique against already submitted subscription actions.

Include PageV4:user_identifierV4:user_identifierperformed_on

Date

Determines the start date of the billable period of each subscription service (it answers to the question “from which date should I start billing this service) that is affected by the subscription action.

scheduled_date

(optional)

User identifier

The user that actually performed the action. The allowed user identifier fields are the following:

billing_effective_date

Date

The date that the action is scheduled to be executed. If not specified then the action will be executed immediately. It is important to note that if the subscription action is submitted as a scheduled one, then no installed items are specified as to also be added through this action

use_proposed_scheduled_date

(optional)

Date The date that the action was actually performedbillable_period_start_date

Boolean

Defines whether the scheduled date automatically calculated and proposed by the system based on business rules, will be automatically set as the subscription's scheduled date or not. Applicable only if the subscription action includes a scheduled date and only if this scheduled date does not meet the business rules.

Tip
Available from CRM.COM R15.0.0

udf_string_1

(optional)

DateDetermines when the subscription services that are affected by the subscription action should be billed by the billing engine.scheduled_date

String

User Defined Field of type String

udf_string_2

(optional)

Date Determines the start date of the billable period of each subscription service (it answers to the question “from which date should I start billing this service) that is affected by the subscription action.

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

DateThe date that the action is scheduled to be executed. If not specified then the action will be executed immediately. It is important to note that if the subscription action is submitted as a scheduled one, then no installed items are specified as to also be added through this action

String	User Defined Field of type String
udf_string_

1

5

(optional)

String

User Defined Field of type String

udf_string_

2

6

(optional)

String

User Defined Field of type String

udf_string_

3

7

(optional)

String

User Defined Field of type String

udf_string_

4

8

(optional)

String

User Defined Field of type String

udf

_string_5

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

String

Float

User Defined Field of type

String

Float

udf_

string

float_

6

4

(optional)

String

Float

User Defined Field of type

String

Float

udf_

string

date_

7

1

(optional)

String

Date	User Defined Field of type

String

Date

udf_

string

date_

8

2

(optional)

String

Date	User Defined Field of type

String

Date

udf_

float

date_

1

3

(optional)

Float

Date	User Defined Field of type

Float

Date

udf_

float

date_

2

4

(optional)

Float

Date	User Defined Field of type

Float

Date

udf

services_to_

float

add_

3

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

services

set

(semi-optional)

Float

User Defined Field of type Float

Set of subscription services to be added objects

The services that will be added on the subscription. Those services might be either new services that should be added and distributed on the subscription or existing services that should be distributed to additional provisioning distributors

services_to_remove_set

(semi-optional)

Set of subscription services to be removed objects

The services that will be undistributed from a specific provisioning distributor. If a service is removed from all provisioning distributors then it is also removed from the subscription

services_to_swap_set

(semi-optional)

Set of subscription services to be swapped objects

A set of services to be swapped, along with the services that will swap them. Mandatory and additional services can be specified to be swapped. The services that will be swapped by another services.

Tip
Available from CRM.COM R14.3.0

installed_items_to_add_set

(semi-optional)

Set of subscription

service

installed item to be added objects

The

services

installed items that will be added on the subscription. Those

services

installed items might be either new

services

installed items that should be added and distributed on the subscription or existing

services

installed items that should be distributed to additional provisioning distributors

services

installed_items_to_remove_set

(semi-optional)

Set of subscription

service

installed item to be removed objects

The

services

installed items that will be undistributed from a specific provisioning distributor. If

a service

an installed item is removed from all provisioning distributors then it is also removed from the subscription

installed

provisioning_

items

distributor_

to_add

labels_set

(optional)

Set of subscription

installed item to be added

provisioning distributor label objects

The

installed items

labels that will be

added

applied on the specified provisioning distributor for that specific subscription.

Those installed items might be either new installed items that should be added and distributed on the subscription or existing installed items that

Each provisioning distributor can be labeled only once per subscription. At least one service or installed item should be distributed to

additional provisioning distributorsinstalled_items_to_remove

each provisioning distributor which is specified in that set

Tip
Available from CRM.COM R14.5.0

Tip
Deprecated from CRM.COM R18.0.0

expenses_set

(optional)

Set of

subscription installed item to be removed objects

Subscription Expenses Objects

The

installed items

expenses that will be

undistributed from a specific provisioning distributor. If an installed item is removed from all provisioning distributors then it is also removed from the subscription

added on the subscription

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

Anchor
amend services installed items referred objects parameters
amend services installed items referred objects parameters
Referred Parameter Objects DataData

Include Page

	V4:amend_subscription_service_add_parameter
	V4:amend_subscription_service_add_parameter

Include Page

	V4:amend_subscription_service_addremove_parameter
	V4:amend_subscription_service_addremove_parameter

Include Page

	V4:amend_subscription_service_removeswap_parameter
	V4:amend_subscription_service_removeswap_parameter

Include Page

	V4:amend_subscription_installed_item_add_parameter
	V4:amend_subscription_installed_item_add_parameter

Include Page

	V4:amend_subscription_installed_item_remove_parameter
	V4:amend_subscription_installed_item_remove_parameter

Include Page

	V4:subscription_provisioning_distributor_labels_parameter
	V4:subscription_provisioning_distributor_labels_parameter

Include Page

	V4:new_subscription_expense_parameter
	V4:new_subscription_expense_parameter

Restrictions

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

Response Data

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

 {
    "token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
    "subscription_identifier" : {
        "number" : "S0000000919"
    },
    "services_to_add_set" : [{
        "service_identifier" : {
            "code" : "Unld98"
        } 
    }],
    "services_to_remove_set" : [{
        "service_identifier" : {
            "code" : "Gold"
        } 
    }],
    "installed_items_to_add_set" : [{
        "installed_item_identifier" : {
            "serial_number" : "cn_decoder004"
        } 
    }],
    "installed_items_to_remove_set" : [{
        "installed_item_identifier" : {
            "serial_number" : "cn_decoder003"
        } 
    }]
}

Response:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

     {
        "data":
        {
            "performed_by": null,
            "action_type":
            {
                "alternative_code": "ASAII",
                "name": "Amend Services and Installed Items",
                "id": "8B5BEA0DDB9B41ABB2F649BF69E9FAFF"
            },
            "submitted_by":
            {
                "person_name": "CRM COM",
                "id": "1",
                "email": null,
                "username": "MPAdministrator"
            },
            "executed_on": "2017-06-15T14:49:53",
            "life_cycle_state": "EXECUTED",
            "subscription":
            {
                "number": "S0000000919",
                "first_activated_date": "2017-06-15T14:43:49",
                "rating_state": "PENDING",
                "accounts_receivable":
                {
                    "number": "ACR0000001220",
                    "name": "ACR0000001220 Test 6975_15_06_2017_01",
                    "id": "D2411E06DCD343ED8D965B87AD65FF11",
                    "life_cycle_state": "ACTIVE",
                    "account_owner":
                    {
                        "company_profile": null,
                        "company_name": null,
                        "name": "Test 6975_15_06_2017_01",
                        "last_name": "6975_15_06_2017_01",
                        "id": "E6421846B02E414BA3C52465D35F31A7",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": null,
                        "title": null,
                        "type": "PERSON",
                        "first_name": "Test",
                        "demographics":
                        {
                            "name_day":
                            {
                                "month": null,
                                "day": null
                            },
                            "id_number": null,
                            "gender": null,
                            "country_of_residence":
                            {
                                "alternative_code": "CYP",
                                "three_character_code": "CYP",
                                "name": "CYPRUS",
                                "id": "181",
                                "two_character_code": "CY"
                            },
                            "date_of_birth":
                            {
                                "month": null,
                                "year": null,
                                "day": null
                            },
                            "industry_sector": null,
                            "passport_number": null,
                            "industry": null,
                            "social_security_number": null,
                            "id_issued_by_country": null,
                            "passport_issued_by_country": null
                        }
                    }
                },
                "id": "91ACEEEFED2342AB903D36521F37416B",
                "life_cycle_state": "NOT_EFFECTIVE",
                "type":
                {
                    "alternative_code": "NC",
                    "name": "Normal - Card",
                    "description": null,
                    "id": "5E8207BE45B744F9BF9C5BAC7DC49FEB"
                }
            },
            "scheduled_date": "2017-06-15T14:49:52",
            "performed_on": null,
            "sub_action_type": null,
            "business_classification_code": "AMEND_SERVICES_INSTALLED_ITEMS",
            "number": "4655",
            "submitted_on": "2017-06-15T14:49:52",
            "id": "9ED16360631947958147C2C12E7564BE",
            "job": null,
            "behavior_code": "AMEND_SERVICES_INSTALLED_ITEMS"
        },
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }

...

Versions Compared

Old Version 2

New Version Current

Key

Resource URL

Parameters

Resource URL

Parameters

Anchor
amend services installed items referred objects parameters
amend services installed items referred objects parameters
Referred Parameter Objects DataData

Restrictions

Response Data

Page Comparison

Versions Compared

Old Version 2

New Version Current

Key

Resource URL

Parameters

Resource URL

Parameters

Anchoramend services installed items referred objects parametersamend services installed items referred objects parametersReferred Parameter Objects DataData

Restrictions

Response Data

Anchor
amend services installed items referred objects parameters
amend services installed items referred objects parameters
Referred Parameter Objects DataData