Skip to main content
Aria Knowledge Central

apply_coupon_to_acct_m Guide

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
 
<auth_key>, <client_acct_id>, <client_no>
<acct_no>, <client_acct_id>
<master_plan_instance_id>, <client_master_plan_instance_id>
<client_master_plan_instance_id>
<coupon_code>
<coupon_code>
<coupon_code>
<coupon_code>
<rule_no>, <client_rule_id>
<scope_no>
<scope_no>
<scope_no>
<scope_no>
<scope_no>
<scope_no>
<scope_no>
<scope_no>
<scope_no>

Additional Guidance:

Input Fields

Field Name: Notes:
scope_no

Override scope number

Allowable values:

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
  • Was this article helpful?