delete_acct_coupon_m Sample Call and Response
This example removes a coupon that is assigned to a specific subscription plan instance on an account and cancels any unconsumed credits associated with that coupon. It is based on the plsql_m_r73.yml definition file.
This example includes every required field and a representative set of commonly used optional fields, not every field the method accepts.
Sample call
{
"rest_call": "delete_acct_coupon_m",
"output_format": "json",
"client_no": 100,
"auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"acct_no": 3004512,
"assigned_plan_instance_no": 900215,
"coupon_cd": "SUMMER25OFF"
}
The rest_call and output_format fields are envelope fields added by the REST layer rather than fields documented on the method itself. The account is identified by acct_no, the Aria-assigned numeric account identifier, rather than by the alternative client-defined client_acct_id. This example scopes the coupon removal to a single subscription plan instance by supplying assigned_plan_instance_no, one of four alternative identifiers the method accepts (assigned_plan_instance_no, assigned_client_plan_instance_id, master_plan_instance_no, and client_master_plan_instance_id). Because the master plan instance identifiers are not supplied here, Aria removes the coupon at the plan instance level rather than at the master plan instance level; if both levels were supplied in the same call, the master plan instance identifiers would take precedence. The coupon_cd field identifies which coupon to remove.
Sample response
{
"error_code": 0,
"error_msg": "OK"
}
An error_code of zero and an error_msg of "OK" indicate that Aria removed the coupon and cancelled its unconsumed credits successfully. This example omits the method's error_details output field, which is a nonpublic field with no client-facing purpose.