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. | ||
![]() | string | 100 | Name of the field you want to associate with this API call. | |
![]() | string | 100 | Corresponding value of the field you want to associate with this API call. |
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 | |
![]() | string | The unique coupon ID |
![]() | string | A long description of the coupon |
![]() | string | Beginning effective date for this coupon |
![]() | string | Final effective date (expiration date) for this coupon |
![]() | long | Number of times a coupon can be used |
![]() | long | The number of times this coupon has been used |
![]() | string | The currency this coupon applies to |
![]() | double | A recurring discount amount expressed as a flat currency amount discount |
![]() | double | A one-time discount amount expressed as a flat currency amount discount |
![]() | double | A recurring discount amount expressed as a percentage of the charges |
![]() | double | A one-time discount amount expressed as a percentage of the charges |
![]() | long | Whether or not the coupon is active |
![]() | long | Aria assigned group number |
![]() | string | Specifies client defined id for coupon group |
![]() | string | Specified coupon group name |
![]() | string | Specifies group description |
![]() | long | Specifies the precedence of the coupon group |
![]() | hash | The credit templates mapped to this coupon |
![]() | long | The unique ID of this credit template |
![]() | string | The name of this credit template |
![]() | double | An indiscriminate flat discount for this credit template |
![]() | double | An indiscriminate percentage discount for this credit template |
![]() | long | The plan number which is being discounted if this credit template is percentage based |
![]() | long | The service number which is being discounted if this credit template is percentage based |
![]() | string | The currency code to which this credit template applies |
![]() | long | The plan number which must be present for this credit template to apply |
![]() | long | The service number which must be present for this credit template to apply |
![]() | long | The alternate service number to use on the eventual invoice for this credit |
![]() | double | Number of times a credit will be created from this template |
![]() | long | How long in between applications of this credit |
![]() | hash | A list of eligible service types |
![]() | string | Service type code for which the credit is applicable. Allowable Values |
![]() | hash | |
![]() | long | The unique ID of this discount rule |
![]() | string | Client-defined name or ID for this discount rule |
![]() | string | The name of this discount rule |
![]() | long | The applicability of this discount rule |
![]() | string | The long description of this discount rule |
![]() | string | Whether or not this is a flat discount or a percentage based one Allowable Values |
![]() | string | The currency code to which this discount rule applies |
![]() | double | The amount of discount, which is either a flat amount or a percentage, based on the value of flat_percent_ind |
![]() | string | Whether or not this discount is applied inline or as its own line |
![]() | string | Indicates whether this discount rule expires after a specific duration, or after a number of uses |
![]() | long | How many months this discount rule will apply |
![]() | long | The maximum number of times a single account can use this discount rule |
![]() | string | A user-friendly public facing description |
![]() | long | The alternate service number to use on the eventual invoice for this discount rule |
![]() | hash | If this rule is part of multiple discount bundles, they are all listed here |
![]() | long | The unique ID of the discount bundle |
![]() | hash | All of the bundles to which this coupon belongs |
![]() | long | The unique ID of the discount bundle |
![]() | string | Client-defined discount bundle ID |
![]() | string | The name of the discount bundle |
![]() | string | The long description of the discount bundle |