Home > Tech Writers Hub > Knowledge Services Sandbox > Aria Crescendo APIs Bucket > get_acct_coupon_details_m

get_acct_coupon_details_m

This API provides detailed information including credit templates, discount rules, and discount bundles for coupons that are assigned to an account or a master plan instance.

For information on error messages generated by this API, see get_acct_coupon_details_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.
  acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts. If passed, only the coupons assigned to this account will be returned.
  OR      
  client_acct_id string 50 Client-defined account identifier.
  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.
  coupon_cd string 30 If passed, only the details for the coupon specified will be returned.
  locale_no long 22 Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients.
  OR      
  locale_name string 50 Name of the locale.
  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.

Output Arguments

Field Name Field Type Description
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.
coupons_detail hash  
brd_arrow.gif out_acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts. If passed, only the coupons assigned to this account will be returned.
brd_arrow.gif out_client_acct_id string This is the client-assigned identifier for the account.
brd_arrow.gif out_master_plan_instance_no long The Master Subscription plan instance number.
brd_arrow.gif out_client_master_plan_instance_id string  
brd_arrow.gif out_coupon_cd string The unique coupon ID
brd_arrow.gif coupon_scope long Specifies the coupon application.   Allowable Values
brd_arrow.gif description string A long description of the coupon
brd_arrow.gif start_date string Beginning effective date for this coupon
brd_arrow.gif exp_date string Final effective date (expiration date) for this coupon
brd_arrow.gif max_uses long Number of times a coupon can be used
brd_arrow.gif total_uses long The number of times this coupon has been used
brd_arrow.gif currency_cd string The currency this coupon applies to
brd_arrow.gif recur_discount_flat_amt double A recurring discount amount expressed as a flat currency amount discount
brd_arrow.gif one_time_discount_flat_amt double A one-time discount amount expressed as a flat currency amount discount
brd_arrow.gif recur_discount_pct double A recurring discount amount expressed as a percentage of the charges
brd_arrow.gif one_time_discount_pct double A one-time discount amount expressed as a percentage of the charges
brd_arrow.gif status_ind long Whether or not the coupon is active
brd_arrow.gif group_no long Aria-assigned group number
brd_arrow.gif client_group_id string Specifies Client-defined ID for coupon group
brd_arrow.gif group_name string Specified coupon group name
brd_arrow.gif group_description string Specifies group description
brd_arrow.gif group_precedence long Specifies the precedence of the coupon group
brd_arrow.gif credit_templates hash The credit templates mapped to this coupon
brd_arrow.gif credit_template_no long The unique ID of this credit template
brd_arrow.gif template_name string The name of this credit template
brd_arrow.gif flat_amount double An indiscriminate flat discount for this credit template
brd_arrow.gif percent_amount double An indiscriminate percentage discount for this credit template
brd_arrow.gif percent_eval_plan_no long The plan number which is being discounted if this credit template is percentage based
brd_arrow.gif percent_eval_service_no long The service number which is being discounted if this credit template is percentage based
brd_arrow.gif currency_cd string The currency code to which this credit template applies
brd_arrow.gif eligible_plan_no long The plan number which must be present for this credit template to apply
brd_arrow.gif eligible_service_no long The service number which must be present for this credit template to apply
brd_arrow.gif alt_service_no_2_apply long The alternate service number to use on the eventual invoice for this credit
brd_arrow.gif num_credits_required long Number of times a credit will be created from this template
brd_arrow.gif credit_interval_months long How long in between applications of this credit
brd_arrow.gif eligible_service_types hash A list of eligible service types
brd_arrow.gif eligible_service_types string Service type code for which the credit is applicable.   Allowable Values
brd_arrow.gif discount_rules hash  
brd_arrow.gif rule_no long The unique ID of this discount rule
brd_arrow.gif client_rule_id string Client-defined name or ID for this discount rule
brd_arrow.gif rule_name string The name of this discount rule
brd_arrow.gif scope_no long The applicability of this discount rule
brd_arrow.gif description string The long description of this discount rule
brd_arrow.gif flat_percent_ind string Whether or not this is a flat discount or a percentage based one   Allowable Values
brd_arrow.gif currency_cd string The currency code to which this discount rule applies
brd_arrow.gif amount double The amount of discount, which is either a flat amount or a percentage, based on the value of flat_percent_ind
brd_arrow.gif inline_offset_ind string Whether or not this discount is applied inline or as its own line
brd_arrow.gif duration_type_ind string Indicates whether this discount rule expires after a specific duration, or after a number of uses
brd_arrow.gif max_applicable_months long How many months this discount rule will apply
brd_arrow.gif max_applications_per_acct long The maximum number of times a single account can use this discount rule
brd_arrow.gif ext_description string A user-friendly public facing description
brd_arrow.gif alt_service_no_2_apply long The alternate service number to use on the eventual invoice for this discount rule
brd_arrow.gif discount_bundle_no hash If this rule is part of multiple discount bundles, they are all listed here
brd_arrow.gif bundle_no long The unique ID of the discount bundle
   brd_arrow.gif discount_rule_period_type hash

Specifies the duration type.

Allowable Values
   brd_arrow.gif max_application_period hash

Number of periods for which this discount rule is valid after the corresponding coupon is assigned to an account.

Example: If the <discount_rule_period_type> is weeks (2) and the <max_application_period> is 3, it means that the discount rule is valid for 3 weeks after the corresponding coupon is assigned to an account.
  brd_arrow.gif total_discount_uses long This displays the total uses of a discount rule applied to a specific master plan instance or a specific account OR a master plan instance AND account depending on how the coupon is applied.
  brd_arrow.gif remaining_discount_uses long This displays the number of remaining coupon uses for the specified account and/or master plan instance under the discount array details for both discount rule/bundle or credit-template-based coupons.
 discount_bundles hash All of the bundles to which this coupon belongs
brd_arrow.gif bundle_no long The unique ID of the discount bundle
brd_arrow.gif client_bundle_id string Client-defined discount bundle ID
brd_arrow.gif bundle_name string The name of the discount bundle
brd_arrow.gif description string The long description of the discount bundle
acct_locale_no long Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts. DEPRECATED
acct_locale_no_2 long Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts.
acct_locale_name string Name of the account level locale.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by MindTouch ®