cancel_recurring_credits_m
Summary
| API Name | cancel_recurring_credits_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 6.35 |
Description
This API cancels any recurring credits that are assigned on an account or master plan instance.
Inputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
| auth_key | string | 32 | No |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
| acct_no | long | 22 | No |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative field: userid or client_acct_id |
| userid | string | 32 | No |
The users unique identifier. Alternative field: acct_no or client_acct_id |
| client_acct_id | string | 50 | No |
Client-defined account identifier. Alternative field: userid or acct_no |
| recurring_credit_no | object | No | ||
| master_plan_instance_no | long | 22 | No |
The Master Subscription plan instance number. Alternative field: client_master_plan_instance_id |
| client_master_plan_instance_id | string | 100 | No |
Client-defined Master plan Subscription plan instance ID. Alternative field: master_plan_instance_no |
| cancel_comments | string | 500 | No |
Additional explanatory text relating to this API call. |
recurring_credit_no fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| recurring_credit_no | long | No |
The identifier for the recurring credit. |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|
| error_codes | object | No |
error_codes fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| out_acct_no | long | 22 | No | |
| out_master_plan_instance_no | long | 22 | No |
The Master Subscription plan instance number. |
| out_client_mp_instance_id | string | 100 | No |
Client-defined Master plan Subscription plan instance ID. |
| recur_credit_no | long | No |
The identifier for the recurring credit. |
|
| error_code | long | No |
The error code for the specific record provided |
|
| error_msg | string | No |
The error message for the specific record provided |