When a coupon is applied to a customer's subscription it will automatically apply the configured discount to all eligible subscription products. The coupon can be configured to be valid for all plans or for specific plans. For each specified plan you can also specify which plan products will get the discount. The default behavior is for the discount to be applied to all plan products in the plan.
| Property | Type | Description |
|---|
discounts | List of Object References. See below | A list of ID's and URI's referencing the catalog discounts this coupon includes. |
eligibilities | List of Objects. See below. | A list of time periods for which certain discounts are eligible. If time limited discounts are not being used, then this is an empty list and all the discounts in discounts have regular availability. Eligabilites cannot overlap |
plans | List of Objects. See below. | A list of special configurations for the plan(s) this coupon applies to. Can be used to specify which plan products do and do not get discounts through this coupon. |
name | String | The name of the coupon
 a customer's subscription i |
description | String | The description of the coupon
omer's subscription it will |
eligibilityStartDate | DateTime | The start date and time of the earliest starting eligability. |
eligibilityEndDate | DateTime | The end date and time of the latest ending eligability. |
status | Enum:{Draft, Ineligible, Active, Retired} | The status of the coupon |
applyToAllPlans | Boolean | If true, then this coupon applies to all plan frequencies for all plans. |
couponCodes | List of Objects. See below. | A list of coupon codes and their associated usages. |
id | Integer | Fusebill generated ID that uniquely identifies this coupon object |
uri | String | The full string path to this resource |
| Property | Type | Description |
|---|
id | Integer | The Fusebill generated ID that uniquely identifies the discount. |
uri | String | The full string path to the discount resource being referenced. |
| Property | Type | Description |
|---|
startDate | DateTime | The timestamp at which this eligibility period begins |
endDate | DateTime | The timestamp at which this eligibility period ends |
discounts | List of Object References. See above | A list of references to discounts the eligibility period applies to |
| Property | Type | Description |
|---|
code | String | The code that can be used to apply this coupon. Fusebill enforces uniqueness.
the configured discount to a |
timesUsed | Integer | The number of times this coupon has been applied to a subscription.
lly apply t |
remainingUsages | Integer | The total number of times this coupon code is permitted to be used. Null implies unlimited usage availability. |
| Property | Type | Description |
|---|
applyToAllProducts | Boolean | If true, then the coupon applies to every product for the specified plan. If false, then each applicable product is specified in planProducts. |
planProducts | List of object references. See below | The subset of plan products the coupon applies to, if applyToAllProducts is false |
id | Integer | The Fusebill generated ID that uniquely identifies the plan resource |
uri | String | The full string path to the plan resource |
| Property | Type | Description |
|---|
planProductId | Integer | The Fusebill generated ID that uniquely identifies the plan product the coupon applies to. |
uri | String | The full string path to the plan product resource. |
