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.
API Specification: |
apply_coupon_to_acct_m
|
Required Fields: |
- <client_no>
- <auth_key>
- <acct_no> or <client_acct_id>
- <coupon_code>
|
Error Codes
Error Code/Description |
Associated Inputs |
|
|
1004: authentication error
Associated Inputs: auth_key, client_id, client_no
|
<auth_key>, <client_acct_id>, <client_no> |
1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id)
Associated Inputs: acct_no, account_no, client_acct_id, user_id, userid, parent_acct_no
|
<acct_no>, <client_acct_id> |
14046: If you passed in an invalid plan_instance_no, this message will appear: "Invalid Plan instance number". If you passed in an invalid master_plan_instance_id, this message will appear: "Invalid master_plan_instance_id".
Associated Inputs: plan_instance_no, master_plan_instance_id, filter_plan_instance_no, percent_eval_plan_instance_no, client_plan_instance_id
Additional Comments: The plan_instance_no or master_plan_instance_id must belong to the account, or it is invalid. The percent_eval_plan_instance_no must belong to the account and also to the MPI given in input.
|
<master_plan_instance_id>, <client_master_plan_instance_id> |
14047: If you passed in an invalid client_plan_instance_id, this message will appear: "Invalid client Plan instance identifier". If you passed in an invalid client_master_plan_instance_id , this message will appear: "Invalid client_master_plan_instance_id".
Associated Inputs: client_plan_instance_id, client_master_plan_instance_id, client_percent_eval_plan_instance_id
|
<client_master_plan_instance_id> |
15001: invalid coupon code
Associated Inputs: coupon_codes
|
<coupon_code> |
15002: coupon expired
Associated Inputs: coupon_codes, coupon_cd
|
<coupon_code> |
15003: coupon already applied to account
Associated Inputs: coupon_cd, coupon_cd
|
<coupon_code> |
15011: The coupon code provided for this account or Master Plan does not match its specified Coupon Applicability Scope, which determines whether the coupon is available at the account level, the Master Plan Instance level, or both.
Associated Inputs: coupon_cd
|
<coupon_code> |
15019: Discount rule no or id is invalid or blank.
Associated Inputs: rule_no > rule_id
|
<rule_no>, <client_rule_id> |
15020: Discount rule scope number is invalid or blank.
Associated Inputs: scope_no
|
<scope_no> |
15021: Plans on override discount rule scope can not be blank.
Associated Inputs: scope_no
Additional Comments: Users enter scope_no: 11 - but Plan not provided.
|
<scope_no> |
15022: Plans on override discount rule scope are invalid.
Associated Inputs: scope_no
Additional Comments: Users enter scope_no: 11 - but Plan not provided.
|
<scope_no> |
15023: Services on override discount rule scope can not be blank.
Associated Inputs: scope_no
Additional Comments: Users enter scope_no: 12 - but Service not provided.
|
<scope_no> |
15024: Services on override discount rule scope are invalid.
Associated Inputs: scope_no
Additional Comments: Users enter scope_no: 12 - but service is Invalid.
|
<scope_no> |
15025: Service on override discount rule scope not assigned to Plan.
Associated Inputs: scope_no
Additional Comments: Users enter scope_no: 13 - but Plan and service are mismatched.
|
<scope_no> |
15026: Items on override discount rule scope can not be blank.
Associated Inputs: scope_no
Additional Comments: Users enter scope_no: 31 - but Item not provided.
|
<scope_no> |
15027: Items on override discount rule scope are invalid.
Associated Inputs: scope_no
Additional Comments: Users enter scope_no: 11 - but Plan is Invalid.
|
<scope_no> |
15028: Duplicate Plans/items/services on override discount rule scope were entered.
Associated Inputs: scope_no
Additional Comments: When duplicate values of items/plans/services are entered twice in the call.
|
<scope_no> |
Additional Guidance:
Input Fields
Field Name: |
Notes: |
scope_no |
Override scope number
Values |
Description |
0 |
All charges |
10 |
All Plan Charges, All Plans |
11 |
All Plan Charges, Specified Plans |
12 |
All Plans, Specified Service Charges |
13 |
Specified Plans/Service Charges |
21 |
All Recurring Service Charges |
22 |
All Usage Service Charges |
23 |
All Activation Service Charges |
30 |
All Item Charges |
31 |
Specified Item Charges |
|