Skip to main content
Aria Knowledge Central

get_acct_coupon_details_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_acct_coupon_details_m
Class account_services_m
Update Version 55

Description

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.

This API includes coupon assignment at the Plan Instance level (assigned_plan_instance_no/assigned_client_plan_instance_id input) as well as Master Plan Instance level (master_plan_instance_no/client_master_plan_instance_id input). When the API is called by passing a value to the Master Plan Instance (MPI) level, it will get the MPI stack level coupon. If the API is called passing a value to the new Plan Instance (PI) level, then it will operate on the PI level coupon. If the API caller passes values at both the Plan Instance and Master Plan Instance level, then the Master Plan Instance inputs take precedence over the specific Plan Instance inputs.

Inputs

Name Type Length Required Description
client_no long 22 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 No

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.
acct_no long 22 No

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.

Alternative field: client_acct_id
client_acct_id string 50 No

Client-defined account identifier.

Alternative field: acct_no
master_plan_instance_no long 22 No

The Master Subscription plan instance number.

Alternative field: client_master_plan_instance_id, assigned_plan_instance_no, or assigned_client_plan_instance_id
client_master_plan_instance_id string 100 No

Client-defined Master plan Subscription plan instance ID.

Alternative field: master_plan_instance_no, assigned_plan_instance_no, or assigned_client_plan_instance_id
coupon_cd string 30 No

If passed, only the details for the coupon specified will be returned.
locale_no long 30 No

Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients.

Alternative field: locale_name
locale_name string 100 No

Name of the locale.

Alternative field: locale_no
include_all_active long   No

Optional input to return coupon details that are active on the account, meaning has been assigned but not fully consumed by the invoice.

Allowed values:

Value Description
0 '0' (default; null is treated as 0) - for backward compatibility, this will return active coupons that have not been fully consumed on product catalog level.
1 '1' - include all active coupons that have not been fully consumed by the invoice but has been assigned to an account or to a master plan instance.
2 '2' - include all coupons (active and inactive) that have been assigned to an account or to a master plan instance.
assigned_plan_instance_no long 22 No

The Aria-assigned unique identifier of the plan instance to which the specific plan instance coupon is assigned.

Alternative field: assigned_client_plan_instance_id, master_plan_instance_no, or client_master_plan_instance_id
assigned_client_plan_instance_id string 100 No

The client-defined unique identifier of the plan instance to which the specific plan instance coupon is assigned.

Alternative field: assigned_plan_instance_no, master_plan_instance_no, or client_master_plan_instance_id

Outputs

Name Type Length Required Description
error_code long   No

Aria-assigned error identifier. 0 indicates no error.
error_msg string   No

Description of any error that occurred. "OK" if there was no error.
Start of coupons_detail object
coupons_detail object   No  
Name Type Length Required Description
▶out_acct_no long   No

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.
▶out_client_acct_id string   No

This is the client-assigned identifier for the account.
▶out_master_plan_instance_no long 22 No

The Master Subscription plan instance number.
▶out_client_master_plan_instance_id string 100 No  
▶out_coupon_cd string   No

The unique coupon ID
▶coupon_scope long 1 No

Specifies the coupon application.

Allowed values:

Value Description
0 Account
1 Master Plan Instance
2 Account and Master Plan Instance
3 Specific Plan Instance level.
▶description string   No

A long description of the coupon
▶start_date string   No

Beginning effective date for this coupon
▶exp_date string   No

Final effective date (expiration date) for this coupon
▶max_uses long   No

Number of times a coupon can be used
▶total_uses long   No

The number of times this coupon has been used
▶currency_cd string   No

Note: This field is deprecated. Aria no longer supports currency_cd.
▶recur_discount_flat_amt double   No

A recurring discount amount expressed as a flat currency amount discount
▶one_time_discount_flat_amt double   No

A one-time discount amount expressed as a flat currency amount discount
▶recur_discount_pct double   No

A recurring discount amount expressed as a percentage of the charges
▶one_time_discount_pct double   No

A one-time discount amount expressed as a percentage of the charges
▶status_ind long   No

Whether or not the coupon is active
▶group_no long   No

Aria-assigned group number
▶client_group_id string   No

Specifies Client-defined ID for coupon group
▶group_name string   No

Specified coupon group name
▶group_description string   No

Specifies group description
▶group_precedence long   No

Specifies the precedence of the coupon group
▶coupon_assignment_no long   No

Specifies the coupon assignment ID
▶coupon_assignment_reason_cd long   No

Specifies the coupon assignment reason code
▶coupon_assignment_effective_date string   No

Specifies the coupon effective date
▶coupon_assignment_comments string   No

Specifies the coupon assignment comments
▶coupon_assignment_date string   No

Specifies the coupon assignment date
▶coupon_message string   No

Coupon message defined at the catalog level that can be subsequently displayed to end users upon successful application of this coupon to their account or to a master plan instance
▶coupon_cancel_date string   No

Specifies the coupon cancel date
Start of credit_templates object
▶credit_templates object   No

The credit templates mapped to this coupon
Name Type Length Required Description
▶▶credit_template_no long   No

The unique ID of this credit template
▶▶template_name string   No

The name of this credit template
▶▶flat_amount double   No

An indiscriminate flat discount for this credit template
▶▶percent_amount double   No

An indiscriminate percentage discount for this credit template
▶▶percent_eval_plan_no long   No

The plan number which is being discounted if this credit template is percentage based
▶▶percent_eval_service_no long   No

The service number which is being discounted if this credit template is percentage based
▶▶currency_cd string   No

The currency code to which this credit template applies
▶▶eligible_plan_no long   No

The plan number which must be present for this credit template to apply
▶▶eligible_service_no long   No

The service number which must be present for this credit template to apply
▶▶alt_service_no_2_apply long   No

The alternate service number to use on the eventual invoice for this credit
▶▶num_credits_required long   No

Number of times a credit will be created from this template
▶▶credit_interval_months long   No

How long in between applications of this credit
Start of eligible_service_types object
▶▶eligible_service_types object   No

A list of eligible service types
Name Type Length Required Description
▶▶▶eligible_service_types string 2 No

Service type code for which the credit is applicable.

Allowed values:

Value Description
RC Recurring Service
US Usage Service
TX Tax Service
AC Activation Service
MS Miscellaneous Service
CN Cancellation Service
OR Order Based Service
MN Minimum Fee Service
End of eligible_service_types object
▶▶total_credit_uses long   No

Display total uses of credit template applied to a specific MPI OR a specific account OR MPI and account depending on coupon scope application. If this parameter is not applicable, then display null or standard output when its not applicable.
▶▶remaining_credit_uses long   No

Display remaining credit template uses for a specific MPI OR a specific account OR MPI and account depending on coupon scope application. If this parameter is not applicable, then display null or standard output when its not applicable.
▶▶credit_interval_weeks long   No

How long in between applications of this credit
▶▶credit_interval_days long   No

How long in between applications of this credit
End of credit_templates object
Start of discount_rules object
▶discount_rules object   No  
Name Type Length Required Description
▶▶rule_no long   No

The unique ID of this discount rule
▶▶client_rule_id string   No

Client-defined name or ID for this discount rule
▶▶rule_name string   No

The name of this discount rule
▶▶scope_no long   No

The applicability of this discount rule
▶▶description string   No

The long description of this discount rule
▶▶flat_percent_ind string   No

Whether or not this is a flat discount or a percentage based one

Allowed values:

Value Description
P Indicates this is a percentage-based discount
F Indicates that this is a flat currency amount discount
▶▶currency_cd string   No

The currency code to which this discount rule applies
▶▶amount double   No

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   No

Whether or not this discount is applied inline or as its own line
▶▶duration_type_ind string   No

Indicates whether this discount rule expires after a specific duration, or after a number of uses
▶▶max_applicable_months long   No

How many months this discount rule will apply
▶▶max_applicable_weeks long   No

How many weeks this discount rule will apply
▶▶max_applicable_days long   No

How many days this discount rule will apply
▶▶max_applications_per_acct long   No

The maximum number of times a single account can use this discount rule
▶▶remainder_discount_rule_indicator long 3 No

When set as 1, it will prorate the discount applied on the initial invoice if the respective charge is prorated and then force the remaining proportion of the discount on its final application. In any of its application, if respective charge is prorated, then the discount also gets prorated. By default it's null. This parameter is applicable only for (a) duration_type_ind = M (months type duration) and (b) duration_type_ind = U (usage count type duration) with flat_percent_ind = F (fixed discount type).
▶▶ext_description string   No

A user-friendly public facing description
▶▶alt_service_no_2_apply long   No

The alternate service number to use on the eventual invoice for this discount rule
Start of discount_bundle_no object
▶▶discount_bundle_no object   No

If this rule is part of multiple discount bundles, they are all listed here
Name Type Length Required Description
▶▶▶bundle_no long   No

The unique ID of the discount bundle
End of discount_bundle_no object
▶▶total_discount_uses long   No

Display total uses of discount rule applied to a specific MPI OR a specific account OR MPI and account depending on coupon scope application. Only to display value when a discount rule has a max application number of uses.
▶▶remaining_discount_uses long   No

Display remaining discount rule uses for a specific MPI OR a specific account OR MPI and account depending on coupon scope application. Only to display value when a discount rule has a max application number of uses.
▶▶scope_overridden string   No

Specifies Y/N if coupon scope is overridden
▶▶scope_label string   No

Charges eligible to receive the discount
End of discount_rules object
Start of discount_bundles object
▶discount_bundles object   No

All of the bundles to which this coupon belongs
Name Type Length Required Description
▶▶bundle_no long   No

The unique ID of the discount bundle
▶▶client_bundle_id string   No

Client-defined discount bundle ID
▶▶bundle_name string   No

The name of the discount bundle
▶▶description string   No

The long description of the discount bundle
End of discount_bundles object
▶plan_instance_no long 22 No

The unique identifier of the master plan instance or supplemental plan instance associated to the coupons.
▶client_plan_instance_id string 100 No

The client-defined unique identifier of the master plan instance or supplemental plan instance associated with the coupons.
End of coupons_detail object
acct_locale_no long 30 No

Note: This field is deprecated. Aria no longer supports acct_locale_no.
acct_locale_name string 100 No

Name of the account level locale.
acct_locale_no_2 long 30 No

Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts.
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.