Home > Aria Crescendo core api > apply_coupon_to_acct_m
apply_coupon_to_acct_m
apply_coupon_to_acct_m
Table of contents
This API assigns a coupon code to a specified account or master plan instance. The appropriate service credits will then be applied to the account or master plan instance based on the credit template associated with the coupon code.
For information on error messages generated by this API, see apply_coupon_to_acct_m error messages.
For information on error messages generated by this API, see apply_coupon_to_acct_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. | |
|
coupon_code | string | 30 | The code of the coupon to which to apply the discount. If code is not valid for any reason, an appropriate error code is returned and the entire transaction (including the supp plan assignment and any possible invoice creation) is rolled back. |
| 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. | ||
 qualifier_name |
string | 100 | Name of the field you want to associate with this API call. | |
| qualifier_value |
string | 100 | Corresponding value of the field you want to associate with this API call. |
Output Arguments
| Field Name | Field Type | Description |
|---|---|---|
| user_success_msg | string | The message to display to account the holder upon successful application of the coupon code they've provided. |
| 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. |
- © Copyright 2019 Aria Developer Central