create_coupon_m

Last updated
Save as PDF

Creates a coupon

Note: The previously existing input and/or output fields <client_item_id>, <client_item_id_out> and/or <filter_client_item_id> were removed from this API call in Release 47.

Input Arguments

Req

Field Name

Field Type

Max Length

Description

client_no

long

Aria-assigned unique identifier indicating the Aria client providing service to this account.

auth_key

string

Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.

coupon_cd

string

Specifies Coupon Code

coupon_desc

string

200

Specifies Coupon description. Translatable.

coupon_msg

string

300

Specifies Coupon Message. Translatable.

status_ind

int

Specifies Coupon status.

Allowable values for status_ind:

Values	Description
1	Active
0	Inactive

no_of_uses

int

Specifies number of uses after which coupon get expires. Related to coupon expiry detail.

start_date

string

Specifies start date. The date is in the format "yyyy-mm-dd"Related to coupon expiry detail

end_date

string

Specifies start date. The date is in the format "yyyy-mm-dd"Related to coupon expiry detail

template

array

Either template, or discount_rule, or discount_bundle is required if not using an existing_template.

credit_template_name

string

300

Recurring credit template name. If both an existing template name and a new template name is provided, the new template name will be used to create a new template.

client_credit_template_id

string

100

Client defined unique id

eligible_plan_no

int

Eligible service plan number. If eligible_plan_no is present then eligible_service_no is also set and vice-versa. This means that coupon can only be applied against a specific type of charge. But If both values are null then it means that coupon can be applied against any change.

eligible_client_plan_id

string

100

Specifies Client defined unique id

eligible_service_no

int

Eligible service number

eligible_client_service_id

string

100

Specifies Client defined unique id

eligible_service_types

string array

Service type code for which the credit is applicable.

Allowable values for eligible_service_type:

Values	Description
RC	Recurring Service
RA	Recurring Arrears Service
SC	Surcharge Service
US	Usage Service
AC	Activation Service
MS	Miscellaneous Service
CN	Cancellation Service
OR	Order Based Service
MN	Minimum Service Fee

discount_type

int

Specifies discount type. Valid values are [1 or 2] 1 - Indicates flat rate 2 - Indicates percentage

discount_amt

float

Specifies discount amount. If discount_type is set to 1, then this range of valid values of this parameter is > 0 to 9999, but if it's set to "2" then its range is > 0 to 100.

no_of_credits

int

This parameter is related to information about generation frequency. i.e. Number of credits If this value is set along with time_between_credits, then it means that generation frequency is multiple.

credit_interval_months

int

Time interval between credits in months

percentage_plan_no

int

Specifies Percentage plan number. This value is only set if discount_type is 2 i.e. discount type is Percentage

percentage_client_plan_id

string

100

Specifies Client defined unique id

percentage_service_no

int

Specifies Percentage service number. This value is only set if discount_type is 2 i.e. discount type is Percentage

percentage_client_service_id

string

100

Specifies Client defined unique id

alt_service_no

int

Specifies Alternative service number. If this value is null, then for coupon can be Service code to use is standard

alt_client_service_id

string

100

Specifies Client defined unique id

currency_cd

string

Specifies the currency code of Template

discount_rule

array

Either discount_rule, or template, or discount_bundle is required if not using an existing_discount_rule.

label

string

Specifies Discount Rule Name. Translatable.

rule_id

string

Specifies client rule id for Discount Rule

description

string

300

Specifies description for the Discount Rule. Translatable.

ext_description

string

300

Specifies description that can be added to invoice/statment and is visible to account holder. Translatable.

flat_percent_ind

string

Specifies whether the discount is going to be flat or percentage based.

Allowable values for flat_percent_ind:

Values	Description
P	Percentage discount type
F	Fixed discount type

amount

float

Specifies the amount of discount.

currency

string

Specifies the currency code of the rule

duration_type_ind

string

Specifies the duration type.

Allowable values for duration_type_ind:

Values	Description
U	Number of uses
M	Duration in months
W	Duration in weeks
D	Duration in days
I	Never expires

max_applicable_months

int

Specifies the duration of the discount in months.

max_applicable_weeks

int

Specifies the duration of the discount in weeks.

Allowable values are 1-999.

max_applicable_days

int

Specifies the duration of the discount in days.

Allowable values are 1-999.

max_applications_per_acct

int

Specifies the number of times the discount can be applied.

remainder_discount_rule_indicator

int

When set to TRUE (1), it will prorate the discount applied on the initial invoice and apply the remaining proportion of the discount on the appropriate invoice. By default it is null. This parameter is only applicable when someone enters max_applicable_months. It will be null if no input is given, otherwise it will be stored as 1 or 0 depending upon what the user enters. In addition, be aware that this attribute only applies when a discount rule is assigned at the plan instance level for advanced recurring services.

inline_offset_ind

string

Specifies how the discount will be displayed in the invoice.Valid values are [I, O]

discount_behavior_type_ind

string

Specifies the discount scope for a discount rule.Valid values are [G, N]

service_code_to_use

int

Specifies which service code to use.

Allowable values for service_code_to_use:

Values	Description
0	Uses same service as the 'charge' line item
1	Uses a specific service

alt_service_no_2_apply

int

Specifies the specific service code to use.

alt_service_id_2_apply

string

100

Client defined unique identifier

applicable_trans_scope

string

Specifies whether the discount is applied to each or all transactions.

Allowable values for applicable_trans_scope:

Values	Description
E	Applies discount to each transaction on the invoice (current behavior)
M	Applies discount to all the transaction on the invoice. Any remaining credit will be carried over to next month.

scope_no

int

Specifies the charges eligible for the discount.

Allowable values for scope_no:

Values	Description
0	All Charges
10	All Plan Charges, All Plans
11	All Plan Charges, Specified Plans
12	All Plans, Specified Service Charges
13	Specified Plan/Service Charges
21	All Recurring Service Charges
22	All Usage Service Charges
23	All Activation Service Charges
30	All Item Charges
31	Specified Item Charges

plans

array

plan_no

int

Specifies the plan that are eligible for the discount. This is mandatory for scope 11 and 13.REST input arrays should be passed in the following format: plans[0][plan_no]=1002&plans[1][plan_no]=1003 etc

client_plan_id

string

100

Specifies the plan that are eligible for the discount. This is mandatory for scope 11 and 13.REST input arrays should be passed in the following format: plans[0][client_plan_id]=1002&plans[0][client_plan_id]=1003 etc

service

array

service_no

int

Specifies the services that are eligible for the discount. This is mandatory for scope 12 and 13. REST input arrays should be passed in the following format: For scope 12 service[0][service_no]=1002&service[1][service_no]=1003 For scope 13 service[0][service_no][0]=10002&service[0][service_no][1]=1001&service[1][service_no][0]=100&service[0][service_no][1]=103

client_service_id

string

100

Specifies the services that are eligible for the discount. This is mandatory for scope 12 and 13. REST input arrays should be passed in the following format: For scope 12 service[0][client_service_id]=1002&service[0][client_service_id]=1003 For scope 13 service[0][client_service_id][0]=10002

item

array

item_no

int

Specifies the inventory items that are eligible for the discount. This is mandatory for scope 31. REST input arrays should be passed in the following format: item[0][item_no]=1002&item[1][item_no]=103

client_sku

string array

100

Client SKU of the NSO/Inventory item

use_all_or_nth_subs_rule

string

Specifies whether to apply discount when 'all' of the plans are under the account or 'some' of the plans are are under the account.

Allowable values for use_all_or_nth_subs_rule:

Values	Description
TRUE	Apply discount when 'all' of the plans are under the account
FALSE	Apply discount when 'some' of the plans are under the account

discount_bundle

array

Either discount_bundle, or template, or discount_rule is required if not using an existing_discount_bundle.

bundle_name

string

300

Specifies the name for the discount bundle.

bundle_id

string

Specifies bundle id for discount Bundle

bundle_description

string

300

Specifies description for the discount Bundle

allow_overlap_ind

string

Specifies if the rules in the bundle can overlap or not.

Allowable values for allow_overlap_ind:

Values	Description
Y	Yes
N	No

rules

array

rule_no

int

Specifies the rules to be grouped in this bundle. REST input arrays should be passed in the following format: rules[1][rule_no]=1002&rules[2][rule_no]=103

rule_id

string

100

Specifies the rules to be grouped in this bundle. REST input arrays should be passed in the following format: rules[1][rule_id]=1002&rules[2][rule_id]=103

existing_template

array

template_no

int

Specifies existing templates to be associated with the coupon. REST input arrays should passed in the following format: existing_template[0][template_no]=1243& existing_template[1][template_no]=1002 etc.

template_id

string

100

Specifies client defined unique identifiers for existing templates to be associated with the coupon. REST input arrays should passed in the following format: existing_template[0][template_id]=1243& existing_template[1][template_id]=1002 etc.

existing_discount_rule

array

rule_no

int

Specifies existing rules to be associated with the coupon. REST input arrays should passed in the following format: existing_discount_rule[0][rule_no]=1243& existing_discount_rule[1][rule_no]=1002 etc.

rule_id

string

100

Specifies client defined unique identifiers for existing rules to be associated with the coupon. REST input arrays should passed in the following format: existing_discount_rule[0][rule_id]=1243& existing_discount_rule[1][rule_id]=1002 etc.

existing_discount_bundle

array

bundle_no

int

Specifies existing bundles to be associated with the coupon. REST input arrays should passed in the following format: existing_discount_bundle[0][bundle_no]=1243& existing_discount_bundle[1][bundle_no]=1002 etc.

bundle_id

string

100

Specifies existing bundles to be associated with the coupon. REST input arrays should passed in the following format: existing_discount_bundle[0][bundle_id]=1243& existing_discount_bundle[1][bundle_id]=1002 etc.

coupon_scope

int

Specifies the coupon application. The parameter is required for EOM Clients

Allowable values for coupon_scope:

Values	Description
1	Coupon can be applied to Account only
2	Coupon can be applied to Master plan instance only
3	Coupon can be applied to Account & Master plan instance

Field Name	Field Type	Description
error_code	long	Aria-assigned error identifier. 0 indicates no error
error_msg	string	Textual description of any error that occurred. "OK" if there was no error.
coupon_cd	string	Coupon Code

Input Arguments

Allowable values for status_ind:

Allowable values for eligible_service_type:

Allowable values for flat_percent_ind:

Allowable values for duration_type_ind:

Allowable values for service_code_to_use:

Allowable values for applicable_trans_scope:

Allowable values for scope_no:

Allowable values for use_all_or_nth_subs_rule:

Allowable values for allow_overlap_ind:

Allowable values for coupon_scope:

Output Arguments