Available from CRM.COM R13.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 identifier | The subscription to be modified. The allowed subscription identifier fields are the following:
| ||||||||||||||||||||||||||||||
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:
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:
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:
Deprecated from CRM.COM R15.0.0 | ||||||||||||||||||||||||||||||
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:
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:
| ||||||||||||||||||||||||||||||
performed_by_unit_identifier (optional) | Unit Identifier | The unit that performed the action. The allowed unit identifier fields are the following:
Available from CRM.COM R14.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) | Date | The 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) | 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) | 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) | 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. Available from CRM.COM R15.0.0 | ||||||||||||||||||||||||||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||||||||||||||||||||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||||||||||||||||||||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||||||||||||||||||||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||||||||||||||||||||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||||||||||||||||||||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||||||||||||||||||||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||||||||||||||||||||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||||||||||||||||||||||||||
(optional) | 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 | ||||||||||||||||||||||||||||||
(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 | ||||||||||||||||||||||||||||||
(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. Available from CRM.COM R14.3.0 | ||||||||||||||||||||||||||||||
(optional) | Set of subscription installed item to be added objects | The installed items that will be added on the subscription. Those installed items might be either new installed items that should be added and distributed on the subscription or existing installed items that should be distributed to additional provisioning distributors | ||||||||||||||||||||||||||||||
(optional) | Set of subscription installed item to be removed objects | The installed items 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 | ||||||||||||||||||||||||||||||
provisioning_distributor_labels_set (optional) | Set of subscription provisioning distributor label objects | The labels that will be applied on the specified provisioning distributor for that specific subscription. Each provisioning distributor can be labeled only once per subscription. At least one service or installed item should be distributed to each provisioning distributor which is specified in that set 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
|
Referred Parameter Objects Data
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"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:
{
"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": ""
}
}