Summary

API Name	delete_acct_coupon_m
Class	account_services_m
Update Version	6.35

Description

This API deletes the coupon from the account or master plan instance and cancels any unconsumed credits on the account or master plan instance associated with the coupon. This API includes coupon assignment at the Plan Instance level (assigned_plan_instance_no/assigned_client_plan_instance_id input) as well as Master Plan Instance level (master_plan_instance_no/client_master_plan_instance_id input). When the API is called by passing a value to the Master Plan Instance (MPI) level, it will delete the MPI stack level coupon. If the API is called passing a value to the new Plan Instance (PI) level, then it will operate on the PI level coupon. If the API caller passes values at both the Plan Instance and Master Plan Instance level, then the Master Plan Instance inputs take precedence over the specific Plan Instance inputs.

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	Yes	Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.
acct_no	long	22	Yes	Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative required field: client_acct_id
client_acct_id	string	50	Yes	Client-defined account identifier. Alternative required field: acct_no
master_plan_instance_no	long	22	No	The Master Subscription plan instance number. Alternative field: client_master_plan_instance_id, assigned_plan_instance_no, or assigned_client_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, assigned_plan_instance_no, or assigned_client_plan_instance_id
coupon_cd	string		Yes	Code of the coupon to remove from the account or master plan instance
assigned_plan_instance_no	long	22	No	The Aria-assigned unique identifier of the plan instance to which the specific plan instance coupon is assigned. Alternative field: assigned_client_plan_instance_id, master_plan_instance_no, or client_master_plan_instance_id
assigned_client_plan_instance_id	string	100	No	The client-defined unique identifier of the plan instance to which the specific plan instance coupon is assigned. Alternative field: assigned_plan_instance_no, master_plan_instance_no, or client_master_plan_instance_id

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.