...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| 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:
|
...
|
| 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 | |||||||||||||||||||||
subscriptionaction_type_identifier (semi-optional) | Subscription action type identifier | The subscription to be modifiedaction type that should be used. The allowed subscription action type identifier fields are the following:
| |||||||||||||||||||||
sub_action_type_identifier (semi-optional) | Accounts Receivable Identifier | The accounts receivable identifier that can be used to perform the subscription modification. The allowed accounts receivable Subscription sub action type identifier | The sub action type that should be used. The allowed subscription sub action type identifier fields are the following:
Note |
| |||||||||||||||||||
action_typeclassification_identifier (optional) | Subscription action type identifierAction Classification Identifier | The subscription action's classification. The allowed subscription action classification identifier fields are the following:
| |||||||||||||||||||||
payment_gateway_card_identifier (optional) | Subscription sub action type identifier | Thesub actiontype that should be used. The allowed subscription sub action type 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_userunit_identifier (optional) User identifier | 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 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 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
| |||||||||||||||||||||
use_proposed_scheduled_date (optional) | DateBoolean | Defines whether the scheduled date of the subscription action. If not specified, then the subscription action will be immediately executedautomatically 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.
| |||||||||||||||||||||
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 unique identifier of the usage authorisation. Only usage authorizations in Blocked life cycle state is allowed to be specified.
| |||||||||||||||||||||
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_string_9 (optional) | String | User Defined Field of type String
| |||||||||||||||||||||
udf_string_10 (optional) | String | User Defined Field of type String
| |||||||||||||||||||||
udf_string_11 (optional) | String | User Defined Field of type String
| |||||||||||||||||||||
udf_string_12 (optional) | String | User Defined Field of type String
| |||||||||||||||||||||
udf_string_13 (optional) | String | User Defined Field of type String
| |||||||||||||||||||||
udf_string_14 (optional) | String | User Defined Field of type String
| |||||||||||||||||||||
udf_string_15 (optional) | String | User Defined Field of type String
| |||||||||||||||||||||
udf_string_16 (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_float_5 (optional) | Float | User Defined Field of type Float
| |||||||||||||||||||||
udf_float_6 (optional) | Float | User Defined Field of type Float
| |||||||||||||||||||||
udf_float_7 (optional) | Float | User Defined Field of type Float
| |||||||||||||||||||||
udf_float_8 (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 | |||||||||||||||||||||
| usage_detail_record_set | Usage Detail Record Objects Set | The set of usage detail records that should be added for each existing subscription service, classified as termed 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 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 |
...
| Expand | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
HTTP Method: POST Request: Body
Response
|
...
| Expand | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
...
| Expand | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
...