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.
| API Specification: |
create_coupon_m
|
| Required Fields: |
- <client_no>
- <auth_key>
- <coupon_cd>
- <template> (array)
- <credit_template_name>
- <discount_type>
- <discount_amt>
- <discount_rule> (array)
- <label>
- <description>
- <ext_description>
- <flat_percent_ind>
- <amount>
- <currency>
- <duration_type_ind>
- <inline_offset_ind>
- <discount_behavior_type_ind>
- <scope_no>
- <discount_bundle> (array)
- <bundle_name>
- <bundle_id>
- <bundle_description>
- <allow_overlap_ind>
|
Additional Guidance
Input Fields
| Field Name |
Notes |
| <status_ind> |
Allowable values
| Values |
Description |
| 1 |
Active |
| 0 |
Inactive |
|
| <eligible_service_types> |
Allowable values
| 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 |
|
| <flat_percent_ind> |
Allowable values
| Values |
Description |
| P |
Percentage discount type |
| F |
Fixed discount type |
|
| <duration_type_ind> |
Allowable values
| Values |
Description |
| U |
Number of uses |
| M |
Duration in months |
| W |
Duration in weeks |
| D |
Duration in days |
| I |
Never expires |
|
| <service_code_to_use> |
Allowable values
| Values |
Description |
| 0 |
Uses same service as the 'charge' line item |
| 1 |
Uses a specific service |
|
| <applicable_trans_scope> |
Allowable values
| 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> |
Allowable values
| 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 |
|
| <use_all_or_nth_subs_rule> |
Allowable values
| 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 |
|
| <allow_overlap_ind> |
Allowable values
| Values |
Description |
| Y |
Yes |
| N |
No |
|
| <coupon_scope> |
Allowable values
| 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 |
|
