get_acct_coupon_details_m Guide
The get_acct_coupon_details_m 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.
API Specification: | |
Required Fields: |
|
Additional Guidance
Input Fields
Field Name | Notes | ||||||||
---|---|---|---|---|---|---|---|---|---|
<include_all_active> |
This provides additional information in tracking coupons when used for discount rules, discount bundles, or credit templates. This parameter can be used to return active coupons that have not been fully consumed at the product catalog level as well as coupons not consumed by the invoice but assigned to an account or master plan instance. The following values are allowed: Allowable Values
|
||||||||
<max_applicable_weeks> | Can be up to 999. | ||||||||
<max_applicable_days> | Can be up to 999. |
Output Fields
Field Name | Notes | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
<coupon_scope> |
Allowable Values
|
||||||||||||||||||
<eligible_service_types> |
Allowable Values
|
||||||||||||||||||
<flat_percent_ind> |
Allowable Values
|
||||||||||||||||||
<discount_rule_period_type> |
Allowable Values
|
||||||||||||||||||
<coupon_cancel_date> |
Specifies the coupon cancel date. Datatype: string |
||||||||||||||||||
<coupon_message> |
Coupon message defined at the catalogue level that can be subsequently displayed to end users upon successful application of this coupon to their account or to a master plan instance. Datatype: string |
||||||||||||||||||
<credit_interval_weeks> |
How long in between applications of this credit. Datatype: long |
||||||||||||||||||
<credit_interval_days> |
How long in between applications of this credit. Datatype: long |
||||||||||||||||||
<scope_label> |
Charges eligible to receive the discount. Datatype: string |
Error Codes
Error Code/Description | Associated Inputs |
---|---|
|
|
|
<auth_key>, <client_id>, <client_no> |
<acct_no>, <account_no>, <client_acct_id>, <user_id>, <userid>, <parent_acct_no> | |
<alt_service_no_to_apply>, <assignment_directive>, <auto_skip_to_next_bill_date>, <client_billing_group_id>, <custom_rate_service_no/custom_rate_client_service_id>, <plan_instance_no>, <plan_instance_service_no>, <client_plan_instance_id>, <client_plan_instance_service_id>, <plan_instance_no>, <plan_instance_service_no>, <client_plan_instance_id>, <client_plan_instance_service_id>, <plan_instance_service_no>, <eligible_plan_no>, <eligible_service_no>, <email>, <force_master_bill_date_reset>, <fulfillment_only>, <include_master_plans>, <include_supp_plans>, <include_billing_groups>, <include_payment_methods>, <include_master_plans>, <include_supp_plans>, <include_billing_groups>, <include_payment_methods>, <invoice_no>, <length_months>, <end_date>, <limit>, <limit_records>, <modify_directive>, <contract_plan_instances_update>, <modify_directive>, <contract_plan_instances_update>, <offset>, <percent_amount>, <percent_eval_plan_instance_no>, <client_percent_eval_plan_instance_id>, <percent_eval_service_no>, <client_percent_eval_service_id>, <phone_ext>, <work_phone_ext>, <plan_unit_inst_status_cd>, <plan_units>, <reason_code>, <start_date>, <end_date>, <start_date>, <end_date>, <status_cd>, <acct_no>, <assignment_directive>, <billing_group_no>, <threshold_billing_rule_no> | |
<locale_name> | |
|
<locale_name>, <master_plan_instance_no> |
|
<plan_instance_no>, <master_plan_instance_id>, <filter_plan_instance_no>, <percent_eval_plan_instance_no>, <client_plan_instance_id> |
|
<client_plan_instance_id>, <client_master_plan_instance_id>, <client_percent_eval_plan_instance_id> |
|
<coupon_cd> |