cancel_unapplied_service_credits_m
This API cancels all the unapplied service credits and any partially used recurring credits on an account or master plan instance.
For information on error messages generated by this API, see cancel_unapplied_service_credits_m Error Messages.
Input Arguments
Req | Field Name | Field Type | Max Length | Description |
---|---|---|---|---|
![]() |
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. |
![]() |
auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
![]() |
credit_ids | string array | Array of credit ids. | |
![]() |
acct_no | long | 22 | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. |
OR | ||||
![]() |
client_acct_id | string | 50 | Client-defined account identifier. |
master_plan_instance_no | long | 22 | The Master Subscription plan instance number. | |
OR | ||||
client_master_plan_instance_id | string | 100 | Client-defined Master plan Subscription plan instance ID. | |
alt_caller_id | string | 30 | Person or process that submitted the API call. This can be someone's user ID, or the name of an application. | |
optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||
string | 100 | Name of the field you want to associate with this API call. | ||
string | 100 | Corresponding value of the field you want to associate with this API call. | ||
application_id | string | 300 | The application identifier in which the API is being used in. (Example: “Sales Force”) | |
application_date | string | 300 | The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API. |
Output Arguments
Field Name | Field Type | Description |
---|---|---|
error_code | long | Aria-assigned error identifier. 0 indicates no error. |
error_msg | string | Description of any error that occurred. "OK" if there was no error. |