It swap one or multiple effective or not effective subscription services belonging to a specific subscription with other subscription services, based on the specified subscription service tiers
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 (optional) | String | Defines if the services should be swapped as an upgrade, downgrade or switch. The supported values are the following: UPGRADE_SERVICE, DOWNGRADE_SERVICE, SWITCH_SERVICE If not specified the system sets the business classification code automatically based on the specified services tiers | ||||||||||||||||||||||||||||||
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:
| ||||||||||||||||||||||||||||||
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:
| ||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||
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
| ||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||
(mandatory) | Set of subscription service swap objects | A set of services pairs that should be swapped. | ||||||||||||||||||||||||||||||
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":"4B19B26D35A24CD7AD8836575D6CD92A",
"subscription_identifier":{"number":"S60144"},
"business_classification_code":"SWITCH_SERVICE",
"performed_by_user_identifier":{"username":"JackH"},
"performed_on":"2014-07-16T05:07:41",
"billing_effective_date" : "2014-07-18T05:07:41",
"billable_period_start_date":"2014-07-18T05:07:44",
"services_swap_set":
[
{
"from_service":{"service_identifier":{"code":"Standard"},},
"to_service":{
"service_identifier":{"code":"Standard +"},
"components_set":[
{
"service_identifier":{"code":"Sports 1"}
}
]
}
}
]
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"action_type": null,
"submitted_on": "2014-07-16T11:40:34",
"sub_action_type": null,
"business_classification_code": "SWITCH_SERVICE",
"number": "420",
"executed_on": "2014-07-16T11:40:34",
"life_cycle_state": "EXECUTED",
"performed_by":
{
"person_name": "Jack Hadjicosti",
"username": "JackH",
"id": "B8650C555C4EA8C741103961276E7773",
"email": "j_hadjicosti@crm.com"
},
"behavior_code": "SWAP_SERVICE",
"submitted_by":
{
"person_name": "Jack Hadjicosti",
"username": "JackH",
"id": "B8650C555C4EA8C741103961276E7773",
"email": null
},
"id": "591999FC64A70368FB19DFA4A2FC8009",
"subscription":
{
"accounts_receivable":
{
"account_owner":
{
"last_name": "Johnson",
"middle_name": null,
"company_profile": null,
"type": "PERSON",
"first_name": "Peter",
"name": "Peter Johnson",
"id": "C73D1572FEA76C37A08945ECE4DECC98",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country": null,
"passport_number": "7839023",
"social_security_number": "98374",
"country_of_residence":
{
"name": "CYPRUS",
"id": "181"
},
"industry_sector":
{
"name": "GOVERNMENTAL",
"id": "A9BDEBD4D8FAEDB0BACE40C041156D12"
},
"date_of_birth":
{
"month": 4,
"day": 6,
"year": 1985
},
"name_day":
{
"month": 6,
"day": 29
},
"id_number": "984783",
"id_issued_by_country":
{
"name": "CYPRUS",
"id": "181"
},
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "192",
"name": "Peter Johnson Premium",
"id": "2C5FC6F615FA9E798487AC0C293ECCE6"
},
"life_cycle_state": "EFFECTIVE",
"number": "S60144",
"type":
{
"name": "United Kingdom",
"id": "1C81FBB1E5D90040F440ECE98D6A368D",
"description": "For subscribers residing in United Kingdom",
"alternative_code": "UK"
},
"id": "3100943651B49A30CE90D5766B5CFD6C"
},
"performed_on": "2014-07-16T05:07:41"
}
}
HTTP Method: POST
Request:
Body:
{
"token":"4B19B26D35A24CD7AD8836575D6CD92A",
"fields_set":"submitted_by,subscription,sub_action_type,job,action_type",
"subscription_identifier":{
"number":"S60708"
},
"business_classification_code":"DOWNGRADE_SERVICE",
"action_type_identifier":{"name":"Swap Service"},
"sub_action_type_identifier":{"name":"DG"},
"performed_by_user_identifier":{"username":"JackH"},
"performed_on":"2014-07-16T05:07:41",
"billing_effective_date" : "2014-07-18T05:07:41",
"billable_period_start_date":"2014-07-18T05:07:44",
"services_swap_set":
[
{
"from_service":{"service_identifier":{"code":"Bronze"}},
"to_service":{
"service_identifier":{"code":"Gold"},
"components_set":[
{
"service_identifier":{"code":"Sports 1"}
}
]
}
}
]
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"action_type": {
"id": "3A5FEE83B487495EBAA33C3E3F99B473",
"name": "Swap Service",
"alternative_code": "SS_1"
},
"sub_action_type": {
"id": "9BC6746F8BF745108CC790F485D53B27",
"name": "DG",
"alternative_code": "D"
},
"submitted_by": {
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"job": null,
"subscription": {
"life_cycle_state": "EFFECTIVE",
"accounts_receivable": {
"account_owner": {
"last_name": "Mika",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Ms",
"first_name": "Dina",
"type": "PERSON",
"id": "9ED00E7228634EF986807DF4D86A3F84",
"name": "Mika Dina",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "USA",
"two_character_code": "US",
"id": "127",
"name": "UNITED STATES",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "14587522",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "ACR000525",
"id": "C8A54A6BB4B9423AA560D6B955CD1271",
"name": "Dina Mika"
},
"number": "S60708",
"type": {
"id": "D433A85FB6CD4880A1BCEEB1E164EFA4",
"name": "London",
"description": "Subscription for London customers",
"alternative_code": "LND"
},
"id": "C9EE8F9CC81143538BE2462684D04733",
"first_activated_date": "2016-02-18T14:42:41",
"rating_state": "PENDING"
}
}
}