...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| Excerpt |
|---|
This method is used to replace an existing subscription with a new one. The initial subscription is replaced in cases in which users require to move:
A single subscription can be replaced by each call. |
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
subscription_identifier
(semi-optional)
...
The subscription to be modified. The allowed subscription identifier fields are the following:
...
accounts_receivable_identifier
(semi-optional)
...
The accounts receivable identifier that can be used to perform the subscription modification. The allowed accounts receivable identifier fields are the following:
...
| 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 |
...
replaced_by_type_identifier
(mandatory)
...
The subscription type of the subscription which will replace the specified subscription. The allowed subscription type identifier fields are the following:
...
business_classification_code
(mandatory)
...
Defines if the subscription should be replaced by a Flexible Subscription Type or a Package Subscription Type. The allowed options are
- REPLACE_SUB_FLEX_TO_FLEX: Replacement is done between a flexible subscription to a flexible subscription
- REPLACE_SUB_FLEX_TO_PACK: Replacement is done between a flexible subscription to a packaged subscription and vice versa
...
action_type_identifier
(optional)
...
The action type that should be used. The allowed subscription action type identifier fields are the following:
...
sub_action_type_identifier
(optional)
...
The sub action type that should be used. The allowed subscription sub action type identifier fields are the following:
...
performed_by_user_identifier
(optional)
...
The user that actually performed the action. The allowed user identifier fields are the following:
...
performed_on
(optional)
...
udf_string_1
(optional)
...
User Defined Field of type String
...
udf_string_2
(optional)
...
User Defined Field of type String
...
udf_string_3
(optional)
...
User Defined Field of type String
...
udf_string_4
(optional)
...
User Defined Field of type String
...
udf_string_5
(optional)
...
User Defined Field of type String
...
udf_string_6
(optional)
...
User Defined Field of type String
...
udf_string_7
(optional)
...
User Defined Field of type String
...
udf_string_8
(optional)
...
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)
...
(optional)
...
The services that will be added on the subscription.
| Tip |
|---|
If the Subscription's Type is of classification Package then any Services added on the Subscription are considered as Additional Services. |
...
(optional)
...
The installed items that might be needed to be added on the subscription in order to be allowed to add the required services
| Tip |
|---|
If the Subscription's Type is of classification Package then any Installed Items added on the Subscription are considered as Additional Installed Items. |
...
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
...
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
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
...
| Tip |
|---|
| Tip |
|---|
Deprecated from CRM.COM R17.0.0 |
| Excerpt |
|---|
This method is used to replace an existing subscription with a new one. The initial subscription is replaced in cases in which users require to move:
A single subscription can be replaced by 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:
| ||||||||
replaced_by_type_identifier (mandatory) | Subscription Type Identifier | The subscription type of the subscription which will replace the specified subscription. The allowed subscription type identifier fields are the following:
| ||||||||
business_classification_code (mandatory) | String | Defines if the subscription should be replaced by a Flexible Subscription Type or a Package Subscription Type. The allowed options are
| ||||||||
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:
| ||||||||
performed_by_user_identifier (optional) | User identifier | The user that actually performed the action. The allowed user 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:
| ||||||||
performed_on (optional) | Date | The date that the action was actually performed | ||||||||
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.
| ||||||||
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) | Billing terms object | The billing terms of the subscription to be created | ||||||||
(optional) | Set of subscription service objects | The services that will be added on the subscription.
| ||||||||
(optional) | Set of subscription installed item objects | The installed items that might be needed to be added on the subscription in order to be allowed to add the required services
| ||||||||
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 subscription_replace referred objects parameters subscription_replace referred objects parameters
Referred Parameter Objects Data
| subscription_replace referred objects parameters | |
| subscription_replace referred objects parameters |
| Include Page | ||||
|---|---|---|---|---|
|
| Include Page | ||||
|---|---|---|---|---|
|
| Include Page | ||||
|---|---|---|---|---|
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST {{server}}/crmapi/rest/v2/subscriptions/replace_subscription Request: Body:
Response:
|