...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| Excerpt |
|---|
It swaps one or multiple installed items belonging to a specific subscription with other installed items |
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:
| ||||||||||
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:
|
| ||
classification_identifier (optional) | Subscription |
| Action Classification Identifier | The |
subscription action's classification. The allowed subscription |
action |
classification identifier fields are the following:
|
|
|
| ||||||||||
job_identifier (optional) | Job identifier | The Job for which the subscription action is performed. The allowed job 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:
| ||||||||
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.
| ||||||||
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:
| ||||||||
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:
|
|
| ||||
performed_on (optional) | Date | The date that the action was actually performed | ||
require_verification (optional) | Boolean | Determines whether the Subscription Action will be fulfilled through a Job
| ||
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 installed items swap objects | A set of installed item 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
|
Anchor installed_items_swapping referred objects parameters installed_items_swapping referred objects parameters
Referred Parameter Objects Data
| installed_items_swapping referred objects parameters | |
| installed_items_swapping referred objects parameters |
| Include Page | ||||
|---|---|---|---|---|
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
...
| Expand | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
...
| Expand | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
HTTP Method: POST Request: Body:
Response:
|
...