Returns details of specified 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.
Additional Guidance
Input Fields
| Field Name |
Notes |
| <include_translations> |
Allowable values
| Values |
Description |
| true |
Translated fields will be fetched in all the locales defined. |
| false |
Translation information will not be fetched. |
|
Output Fields
| Field Name |
Notes |
| <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. |
|
| <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 |
|
| <inline_offset_ind> |
Allowable values
| Values |
Description |
| I |
Inline |
| O |
Offset |
|
| <service_code_to_use> |
Allowable values
| Values |
Description |
| 0 |
Uses the same service as the 'charge' line item |
| 1 |
Uses a specific service |
|
| <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 |
|
| <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 |
|
