Home > Aria6 User Documentation > Aria6 core api > get_coupon_details
get_coupon_details
get_coupon_details
Get coupon detailed information including credit templates, discount rules, discount bundles.
Input Arguments
| Req | Field Name | Field Type | Max Length | Description |
|---|---|---|---|---|
 | client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. |
| 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 | 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. | ||
| coupon_cd | string | 30 | If passed, only the details for the coupon specified will be returned. | |
| 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. | ||
 qualifier_name | string | 100 | Name of the field you want to associate with this API call. | |
| 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 | hash | |
| out_coupon_cd | string | The unique coupon ID |
| description | string | A long description of the coupon |
| start_date | string | Beginning effective date for this coupon |
| exp_date | string | Final effective date (expiration date) for this coupon |
| max_uses | long | Number of times a coupon can be used |
| total_uses | long | The number of times this coupon has been used |
| currency_cd | string | The currency this coupon applies to |
| recur_discount_flat_amt | double | A recurring discount amount expressed as a flat currency amount discount |
| one_time_discount_flat_amt | double | A one-time discount amount expressed as a flat currency amount discount |
| recur_discount_pct | double | A recurring discount amount expressed as a percentage of the charges |
| one_time_discount_pct | double | A one-time discount amount expressed as a percentage of the charges |
| status_ind | long | Whether or not the coupon is active |
| group_no | long | Aria assigned group number |
| client_group_id | string | Specifies client defined id for coupon group |
| group_name | string | Specified coupon group name |
| group_description | string | Specifies group description |
| group_precedence | long | Specifies the precedence of the coupon group |
| credit_templates | hash | The credit templates mapped to this coupon |
| credit_template_no | long | The unique ID of this credit template |
| template_name | string | The name of this credit template |
| flat_amount | double | An indiscriminate flat discount for this credit template |
| percent_amount | double | An indiscriminate percentage discount for this credit template |
| percent_eval_plan_no | long | The plan number which is being discounted if this credit template is percentage based |
| percent_eval_service_no | long | The service number which is being discounted if this credit template is percentage based |
| currency_cd | string | The currency code to which this credit template applies |
| eligible_plan_no | long | The plan number which must be present for this credit template to apply |
| eligible_service_no | long | The service number which must be present for this credit template to apply |
| alt_service_no_2_apply | long | The alternate service number to use on the eventual invoice for this credit |
| num_credits_required | double | Number of times a credit will be created from this template |
| credit_interval_months | long | How long in between applications of this credit |
| eligible_service_types | hash | A list of eligible service types |
| eligible_service_types | string | Service type code for which the credit is applicable. Allowable Values |
| discount_rules | hash | |
| rule_no | long | The unique ID of this discount rule |
| client_rule_id | string | Client-defined name or ID for this discount rule |
| rule_name | string | The name of this discount rule |
| scope_no | long | The applicability of this discount rule |
| description | string | The long description of this discount rule |
| flat_percent_ind | string | Whether or not this is a flat discount or a percentage based one Allowable Values |
| currency_cd | string | The currency code to which this discount rule applies |
| amount | double | The amount of discount, which is either a flat amount or a percentage, based on the value of flat_percent_ind |
| inline_offset_ind | string | Whether or not this discount is applied inline or as its own line |
| duration_type_ind | string | Indicates whether this discount rule expires after a specific duration, or after a number of uses |
| max_applicable_months | long | How many months this discount rule will apply |
| max_applications_per_acct | long | The maximum number of times a single account can use this discount rule |
| ext_description | string | A user-friendly public facing description |
| alt_service_no_2_apply | long | The alternate service number to use on the eventual invoice for this discount rule |
| discount_bundle_no | hash | If this rule is part of multiple discount bundles, they are all listed here |
| bundle_no | long | The unique ID of the discount bundle |
| discount_bundles | hash | All of the bundles to which this coupon belongs |
| bundle_no | long | The unique ID of the discount bundle |
| client_bundle_id | string | Client-defined discount bundle ID |
| bundle_name | string | The name of the discount bundle |
| description | string | The long description of the discount bundle |
- © Copyright 2021 Aria Developer Central