cancel_instance_contract_m
It cancels an existing multi plan instance contract for a specified account holder and one or more plan instances.
For information on error messages generated by this API, see cancel_instance_contract_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. | ||||||
![]() |
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. | |||||||
![]() |
contract_no | long | 22 | Aria-assigned unique contract identifier. | ||||||
OR | ||||||||||
client_contract_id | string | 100 | Client assigned unique contract identifier.. | |||||||
update_comments | string | 300 | Comments provided at time of last contract update. | |||||||
close_status | long | 2 |
Contract Closure Status (per the allowable values legend) Allowable values for close_status:
|
|||||||
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. |
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. |