| Tip |
|---|
| Excerpt |
|---|
This method adds the usage of one or multiple subscription services belonging on a specific subscription. |
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:
...
| Tip |
|---|
For releases prior to CRM.COM R13.0.0 the subscription_identifier is mandatory |
...
accounts_receivable_identifier
(semi-optional)
...
| Tip |
|---|
| Excerpt |
|---|
This method adds the usage of one or multiple subscription services belonging on a specific subscription. |
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 | Thesub actiontype that should be used. The allowed subscription sub action type 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 | |||||||||||||||||||||||||
| Include Page | V4:subscription_action_type_identifier | V4:subscription_action_type_identifier | sub_action_type_identifier (optional) | Subscription sub action type identifier | The unit that performed the action. The allowed unit identifier fields are the following: | Thesub actiontype that should be used. The allowed subscription sub action type
| action_type_identifier (optional) | Subscription action type identifier |
| |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 answerstothe question “from which date should I start billing this service) that is affected by the subscription action. | ||||||||||||||||||||||||
scheduled_date (optional) | Date | Defines the scheduled date of the subscription action. If not specified, then the subscription action will be immediately executed
| ||||||||||||||||||||||||
intended_currency_identifier (optional) | Currency Identifier | The currency that the user was intended to use for the added usage. If specified then it is validated against the currency of the specified accounts receivable and if they don't match then an erroris throw. Note that the intended currency is not saved within CRM.COM; it is just used for validation purposes. The allowed currency identifier fields are the following:
| ||||||||||||||||||||||||
usage_authorisation_id (optional)
| String | The transaction reference number unique identifier of the performed subscription action. The transaction reference number is unique against already submitted subscription actionsusage authorisation. Only usage authorizations in Blocked life cycle state is allowed to be specified.
| ||||||||||||||||||||||||
performed_by_user_identifierudf_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 | identifier||||||||||||||||||||||||
| Include Page | V4:user_identifier | V4:user_identifier | performed_by_unit_identifierDefined Field of type String | |||||||||||||||||||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||
udf_string_5 (optional) | Unit Identifier | |||||||||||||||||||||||||
| Include Page | V4:unit_identifier | V4:unit_identifier |
| Tip |
|---|
Available from CRM.COM R14.0.0 |
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_string_9
(optional)
User Defined Field of type String
| Tip |
|---|
Available from CRM.COM R12R14.12.0 |
intendedudf_currencystring_identifier10
(optional)
The currency that the user was intended to use for the added usage. If specified then it is validated against the currency of the specified accounts receivable and if they don't match then an erroris throw. Note that the intended currency is not saved within CRM.COM; it is just used for validation purposes. The allowed currency identifier fields are the following:
User Defined Field of type String
| Tip |
|---|
Available from CRM.COM R14.2.0 |
udf_string_11
(optional)
User Defined Field of type String
| Tip |
|---|
Available from CRM.COM R12R14.02.0 |
usageudf_authorisationstring_id12
(optional)
The unique identifier of the usage authorisation. Only usage authorizations in Blocked life cycle state is allowed to be specified.User Defined Field of type String
| Tip |
|---|
Available from CRM.COM R13R14.02.0 |
udf_string_1 13
(optional)
User Defined Field of type String
| Tip |
|---|
Available from CRM.COM R14.2.0 |
udf_string_
14
(optional)
User Defined Field of type String
| Tip |
|---|
Available from CRM.COM R14.2.0 |
udf_string_
15
(optional)
User Defined Field
of type String
| Tip |
|---|
Available from CRM.COM R14.2.0 |
udf_string_
16
(optional)
User Defined Field of type String
| Tip |
|---|
Available from CRM.COM R14.2.0 |
udf_stringfloat_51
(optional)
Float
User Defined Field of type StringFloat
udf_stringfloat_6 2
(optional)
Float
User Defined Field of type StringFloat
udf_stringfloat_73
(optional)
Float
User Defined Field of type StringFloat
udf_stringfloat_84
(optional)
Float
User Defined Field of type StringFloat
udf_float_
5
(optional)
User Defined Field of type Float
| Tip |
|---|
Available from CRM.COM R14.2.0 |
udf_float_
6
(optional)
User Defined Field of type Float
| Tip |
|---|
Available from CRM.COM R14.2.0 |
udf_float_
7
(optional)
User Defined Field of type Float
| Tip |
|---|
Available from CRM.COM R14.2.0 |
udf_float_
8
(optional)
User Defined Field of type Float
| Tip |
|---|
Available from CRM.COM R14.2.0 |
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
fields_set
(optional)
A list of fields that should be included in the results. If not specified then all the available fields will be returned
| Tip |
|---|
Anchor services_add_usage referred objects parameters services_add_usage referred objects parameters
Referred Parameter Objects Data
| services_add_usage referred objects parameters | |
| services_add_usage referred objects parameters |
...