Home > Aria Crescendo Documentation > Aria Crescendo core api > apply_coupon_to_acct_m

apply_coupon_to_acct_m

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.

For information on error messages generated by this API, see apply_coupon_to_acct_m Error Messages.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string 50 Client-defined account identifier.
required-icon.png coupon_code string 30 The code of the coupon to which to apply the discount. If code is not valid for any reason, an appropriate error code is returned and the entire transaction (including the supp plan assignment and any possible invoice creation) is rolled back.
  master_plan_instance_no long 22 The Master Subscription plan instance number.
  OR      
  client_master_plan_instance_id string 100 Client-defined Master plan Subscription plan instance ID.
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
  coupon_assignment_reason_cd long 22 The code of the reason the coupon is being applied.
  coupon_assignment_comments string   Any important comments about the coupon to be noted. 
  coupon_assignment_effective_date string 10 The date the coupon will take effect on the account/plan instance, in yyyy-mm-dd format.
  override_discount_rule_scope hash   This field overrides the discount rule scope set at "Marketing Catalog".
    brd_arrow.gif rule_no long 22 Discount rule no associated to the coupon.
    brd_arrow.gif client_rule_id string 100 Client defined rule id associated to the coupon.
    brd_arrow.gif scope_no long  22

Override scope number. Allowable values include: 

Allowable values for scope_no:

    brd_arrow.gif plan_service_detail    

Array of plans which can be overridden.

Notes: For scope_no 11, only plan_no information will be considered and service_detail will be ignored. For scope_no 12, only service_details will be considered. plan_no, client_plan_Id will be ignored. For scope_no 13, both plan_no detail and service_detail will be considered and validated.For all other scopes, the plan_details will be ignored.

       brd_arrow.gifbrd_arrow.gif type long 22 Aria unique catalog plan number.
       brd_arrow.gifbrd_arrow.gif client_plan_id string 100 Client defined plan identifier.
       brd_arrow.gifbrd_arrow.gif service_detail     List of services under the plan number.
         brd_arrow.gifbrd_arrow.gifbrd_arrow.gif type      
           brd_arrow.gifbrd_arrow.gifbrd_arrow.gifbrd_arrow.gif service_no long 22 Aria unique catalog service number.
           brd_arrow.gif​​​​​​​brd_arrow.gif​​​​​​​brd_arrow.gifbrd_arrow.gif client_service_id string 100 Client defined service identifier.
       brd_arrow.gif​​​​​​​brd_arrow.gif​​​​​​​ item_detail     Array of plans which can be overridden. Supply the array for scope_no 31.
         brd_arrow.gif​​​​​​​brd_arrow.gif​​​​​​​brd_arrow.gif type      
           brd_arrow.gif​​​​​​​brd_arrow.gif​​​​​​​brd_arrow.gifbrd_arrow.gif item_no long 22 Aria unique item number.
           brd_arrow.gif​​​​​​​brd_arrow.gif​​​​​​​brd_arrow.gifbrd_arrow.gif client_sku string 100 Client defined item identifier.
 

Output Arguments

Field Name Field Type Description
user_success_msg string The message to display to account the holder upon successful application of the coupon code they have provided.
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
coupon_assignment_no long The ID assigned to the coupon.
coupon_assignment_effective_date string The date the coupon will take effect on the account/plan instance, in yyyy-mm-dd format.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.