...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
This method is changing the location of an existing subscription. The method can be applied on a single subscription only
| Tip |
|---|
Available from CRM.COM R5.0.0 |
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
subscription_identifier
(semi-optional)
...
| Excerpt |
|---|
This method is changing the location of an existing 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:
| ||||||||||
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:
|
|
|
|
|
|
|
transaction_ |
reference_ |
number (optional) |
| String | The |
transaction reference number of the formed 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 | |||
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
|
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) | Address object | The address of the subscription to be created
| ||
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_objects parameters subscription_objects parameters
Referred Parameter Objects Data
| subscription_objects parameters | |
| subscription_objects parameters |
...
| Expand | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
...