Subscription Discounts
The available fields in the ‘Subscription Discounts' data source and their corresponding descriptions are listed below.
| Field | Description |
|---|---|
| Subscription Discounts ID | An immutable, unique id for the discount. It is always auto-generated. |
| Invoice Name | The name of the discount as it should appear on customer-facing pages and documents, such as invoices and hosted pages. This is auto-generated based on the type, amount, and currency_code of the discount. For example, it can be 10% off or 10$ off. |
| Percentage | The percentage of the original amount that should be deducted from it. |
| Amount | The value of the discount. The format of this value depends on the kind of currency. |
| Currency Code | The currency code (ISO 4217 format) of the discount. This is only applicable when discount.type is fixed_amount. |
| Duration Type | Specifies the time duration for which this discount is attached to the subscription. |
| Type | The type of discount. Possible values are: fixed_amount : *The specified amount will be given as discount.*percentage: The specified percentage will be given as discount. |
| Apply Till | Specifies till when the limited period discount is applicable. This attribute will be sent in the response only for limited_period duration type discount. |
| Applied Count | Specifies the number of times the discount has been applied. |
| Period | The duration of time for which the discount is attached to the subscription, in period_units. Applicable only when duration_type is limited_period. |
| Period Unit | The unit of time for period. Applicable only when duration_type is limited_period. |
| Apply On | The amount on the invoice to which the discount is applied. |
| Item Price ID | The ID of the item price in the subscription to which the discount is to be applied. Relevant only when apply_on = specific_item_price. |
| Subscription ID | The unique identifier of the subscription resource. You have the option to specify this value when creating a customer. If not specified, Chargebee automatically generates a unique identifier. |
| Creation Date | Timestamp indicating when this discount was created. |
| Included In MRR | The discount is included in MRR calculations for your site. This attribute is only applicable when duration_type is one_time and when the feature is enabled in Chargebee. Also, if the site-level setting is to exclude one-time discounts from MRR calculations, this value is always returned as false. |
Was this article helpful?