Coupons
The available fields in the ‘Coupons' data source and their corresponding descriptions are listed below.
| Field | Description |
|---|---|
| Currency | The currency code (ISO 4217 format) of the coupon. Applicable for fixed_amount coupons alone. |
| Duration Type | Displays if the coupon can be used one_time, forever, or for a limited_period. |
| Redemptions | Displays the number of times a coupon was redeemed. |
| Created On | Timestamp indicating when this coupon was created. |
| Valid Till | Displays the date until which the coupon can be applied to new subscriptions. |
| Coupon ID | Displays the unique identifier for the coupon. |
| Addon Applicability | Displays if the coupon can be applied to add-ons. Possible values are none, all, specific, not_applicable. |
| Maximum Redemptions | Displays the maximum number of times the coupon can be redeemed. |
| Duration | Displays the duration in months for the coupon to be applied. Applicable only for limited period coupon. |
| Apply On | Displays the invoice items for which this discounts need to be applied. Possible values are invoice_amount, each_specified_item. |
| Name | Displays the coupon name. |
| Archived On | Timestamp indicating when this coupon was archived. |
| Invoice Name | Displays the invoice name of the coupon. |
| Discount Percentage | Displays the discount value in percentage. |
| Status | Displays the status of the coupon. Possible values are active, expired, archived, deleted. |
| Discount Type | Specifies the time duration this coupon is applicable. Possible values are one_time, forever, limited_period. |
| Plan Applicability | Displays if the coupon can be applied to plans. Possible values are none, all, specific, not_applicable. |
| Discount Amount | Displays the discount value in dollars. |
Was this article helpful?