delete_acct_coupon_m Guide

Last updated
Save as PDF

The delete_acct_coupon_m API deletes the coupon from the account, master plan instance stack, or the individual plan instance, and cancels any unconsumed credits on the account, master plan instance stack, or individual plan instance associated with the coupon.

API Specification:	delete_acct_coupon_m
Required Fields:	<client_no> <auth_key> <acct_no> or <client_acct_id> <coupon_cd>

Additional Guidance

For coupon application: if you provide both a master plan instance number or id and a plan instance number or id, the master plan instance number takes precedence and the coupon will apply to the master plan instance stack.
For coupon application: previously, this API accepted a supplemental plan number or id in the master plan instance number or id fields; now they only accept master plan values.

Error Codes

Error Code/Description	Associated inputs
1001: unexpected error
1002: no data found
1004: authentication error	<auth_key>, <client_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)	<acct_no>, <account_no>, <client_acct_id>, <user_id>, <userid>, <parent_acct_no>
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". 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.	<plan_instance_no>, <master_plan_instance_id>, <filter_plan_instance_no>, <percent_eval_plan_instance_no>, <client_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".	<client_plan_instance_id>, <client_master_plan_instance_id>, <client_percent_eval_plan_instance_id>
15029: The coupon cannot be deleted since the coupon's application scope, which determines whether the coupon was available at the account level, the master plan instance level, specific plan instance or a combination of account and master plan instance level, does not match the coupon assignment account or plan instance identifier.	<application_scope>