POST subscriptions/change_subscription_distribution
- Former user (Deleted)
- Joseph Ioannou (Unlicensed)
- Georgia Kountouri
- p_demou (Deactivated)
This method changes the provisioning distribution of either existing subscription services or installed items within the same subscription. The method can be applied on a single subscription only
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:
For releases prior to CRM.COM R13.0.0 the subscription_identifier is mandatory | ||||||||||||||||||||||||||||||
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 Available from CRM.COM R13.0.0 | ||||||||||||||||||||||||||||||
business_classification_code (mandatory) | String | Defines whether the subscription's distribution information will be changed in general (including service and/or installed items distribution) or whether the distribution of installed items bundles will be changed only. Available values are MOVE_ITEM_TO_DISTRIBUTOR and CHANGE_BUNDLE_DISTRIBUTION. Default value if not specified is MOVE_ITEM_TO_DISTRIBUTOR Available from CRM.COM R14.3.0 | ||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||
transaction_reference_number (optional) | String | The transaction reference number of the performed subscription action. The transaction reference number is unique against already submitted subscription actions. Available from CRM.COM R13.0.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 Deprecated from CRM.COM R18.0.0 | ||||||||||||||||||||||||||||||
performed_by_business_unit_identifier (optional) | Business Unit Identifier | The business unit that performed the action. The allowed business unit identifier fields are the following:
Available from CRM.COM R18.0.0 | ||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||
(semi-optional) | Set of subscription services distribution objects | The subscription services whose distribution will be updated. The set is optional only if subscription installed items distribution will be modified through the subscription action, otherwise the set is mandatory If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [
{
"action": "update",
...........
},
{
"action": "remove",
...........
},
{
"action": "add",
...........
}
]
Note:For services distribution set, supported actions are New & Remove | ||||||||||||||||||||||||||||||
installed_items_distribution_set (semi-optional) | Set of subscription installed items distribution objects | The subscription installed items whose distribution will be updated. The set is optional only if subscription services distribution will be modified through the subscription action, otherwise the set is mandatory If no records are specified in the set then nothing will be updated. To update a record use "action" : "update". To remove a record use "action" : "remove". To add a record use "action" : "add". Different actions can be used within the same set. For example: "set": [
{
"action": "update",
...........
},
{
"action": "remove",
...........
},
{
"action": "add",
...........
}
]
Note:For installed items distribution set, supported actions are New & Remove | ||||||||||||||||||||||||||||||
swap_installed_items_distribution_set (semi-optional) | Set of subscription installed items swap distribution objects | The subscription installed items whose distribution will be swapped. The set is mandatory only if the subscription action's business classification code indicates that installed items distribution will be swapped. In this case at least one set of installed item must be specified. | ||||||||||||||||||||||||||||||
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":"6CBB6D43FAFC4CF09B3498ABF0E18E83",
"subscription_identifier" : {"number":"S60149"},
"services_distribution_set":
[
{
"action" : "remove",
"service_identifier":{"code":"Bronze"},
"provisioning_distributor_identifier":{"name":"Twin 2"}
},
{
"action" : "new",
"service_identifier":{"code":"Bronze"},
"provisioning_distributor_identifier":{"name":"Twin 1"}
}
],
"installed_items_distribution_set":
[
{
"action" : "new",
"installed_item_identifier":{"serial_number":"sc1000000028"},
"provisioning_distributor_identifier":{"name":"Twin 2"}
},
{
"action" : "remove",
"installed_item_identifier":{"serial_number":"d1000000042"},
"provisioning_distributor_identifier":{"name":"Twin 2"}
}
]
}
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"scheduled_date": "2015-05-13T16:50:44",
"submitted_on": "2015-05-13T16:50:44",
"life_cycle_state": "EXECUTED",
"performed_by":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
},
"business_classification_code": "MOVE_ITEM_TO_DISTRIBUTOR",
"number": "1068",
"behavior_code": "CHANGE_SUBSCRIPTION_DISTR",
"id": "6BA7534D72444CCF9DF18756D9D8636A",
"submitted_by":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
},
"subscription":
{
"life_cycle_state": "EFFECTIVE",
"accounts_receivable":
{
"account_owner":
{
"last_name": "Havier",
"life_cycle_state": "FINANCIAL",
"first_name": "Shemar",
"type": "PERSON",
"id": "E21381FCC07AB01BAAC3851B6C00FFE5",
"name": "Shemar Havier",
"demographics":
{
"country_of_residence":
{
"three_character_code": "USA",
"two_character_code": "US",
"id": "127",
"name": "UNITED STATES"
},
"name_day":
{
},
"date_of_birth":
{
}
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000409",
"id": "090CB2677C088E85F201DCF20C6D4529",
"name": "Shemar Havier 1"
},
"number": "S60149",
"type":
{
"log_information":
{
"updated_date": "2015-05-08T17:15:21",
"created_date": "2014-06-23T14:59:40",
"created_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"alternative_code": "MG"
},
"updated_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
}
},
"id": "3100B0D56E7C7EADF073C34BCE1E42AF",
"name": "London",
"alternative_code": "LND"
},
"id": "1DB334FF2F8B26344BF18AA5CB12FE8C"
},
"performed_on": "2015-05-13T16:50:44",
"executed_on": "2015-05-13T16:50:44"
}
}