cancel_recurring_credits_m
This API cancels any recurring credits that are assigned on an account or Master Plan Instance.
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. |
acct_no | long | 22 | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. | |
OR | ||||
userid | string | 32 | The users unique identifier. | |
OR | ||||
client_acct_id | string | 50 | Client-defined account identifier. | |
recurring_credit_no | long array | The identifier for the recurring credit. | ||
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. | |
cancel_comments | string | 500 | Additional explanatory text relating to this API call. | |
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. |
error_codes | hash | |
long | ||
long | The Master Subscription Plan instance number. | |
string | Client-defined Master Plan Subscription Plan instance ID. | |
long | The identifier for the recurring credit. | |
long | The error code for the specific record provided | |
string | The error message for the specific record provided |