Create a discount
Creates a new discount.
If successful, your response includes a copy of the new discount entity.
Request Body
Amount to discount by. For percentage discounts, must be an amount between 0.01 and 100. For flat and flat_per_seat discounts, amount in the lowest denomination for a currency.
Short description for this discount for your reference. Not shown to customers.
Type of discount. Determines how this discount impacts the checkout or transaction total.
Whether this discount can be redeemed by customers at checkout (true) or not (false).
Unique code that customers can use to redeem this discount at checkout. Use letters and numbers only, up to 16 characters. Not case-sensitive.
If omitted and enabled_for_checkout is true, Paddle generates a random 10-character code.
Supported three-letter ISO 4217 currency code. Required where discount type is flat or flat_per_seat.
Whether this discount applies for multiple subscription billing periods (true) or not (false). If omitted, defaults to false.
Number of subscription billing periods that this discount recurs for. Requires recur. null if this discount recurs forever.
Subscription renewals, midcycle changes, and one-time charges billed to a subscription aren't considered a redemption. times_used is not incremented in these cases.
Maximum number of times this discount can be redeemed. This is an overall limit for this discount, rather than a per-customer limit. null if this discount can be redeemed an unlimited amount of times.
Paddle counts a usage as a redemption on a checkout, transaction, or the initial application against a subscription. Transactions created for subscription renewals, midcycle changes, and one-time charges aren't considered a redemption.
Product or price IDs that this discount is for. When including a product ID, all prices for that product can be discounted. null if this discount applies to all products and prices.
RFC 3339 datetime string of when this discount expires. Discount can no longer be redeemed after this date has elapsed. null if this discount can be redeemed forever.
Expired discounts can't be redeemed against transactions or checkouts, but can be applied when updating subscriptions.
Your own structured key-value data.
Response
Represents a discount entity.
Unique Paddle ID for this discount, prefixed with dsc_.
Whether this entity can be used in Paddle.
Short description for this discount for your reference. Not shown to customers.
Whether this discount can be redeemed by customers at checkout (true) or not (false).
Unique code that customers can use to redeem this discount at checkout. Not case-sensitive.
Type of discount. Determines how this discount impacts the checkout or transaction total.
Amount to discount by. For percentage discounts, must be an amount between 0.01 and 100. For flat and flat_per_seat discounts, amount in the lowest denomination for a currency.
Supported three-letter ISO 4217 currency code. Required where discount type is flat or flat_per_seat.
Whether this discount applies for multiple subscription billing periods (true) or not (false).
Number of subscription billing periods that this discount recurs for. Requires recur. null if this discount recurs forever.
Subscription renewals, midcycle changes, and one-time charges billed to a subscription aren't considered a redemption. times_used is not incremented in these cases.
Maximum number of times this discount can be redeemed. This is an overall limit for this discount, rather than a per-customer limit. null if this discount can be redeemed an unlimited amount of times.
Paddle counts a usage as a redemption on a checkout, transaction, or the initial application against a subscription. Transactions created for subscription renewals, midcycle changes, and one-time charges aren't considered a redemption.
Product or price IDs that this discount is for. When including a product ID, all prices for that product can be discounted. null if this discount applies to all products and prices.
RFC 3339 datetime string of when this discount expires. Discount can no longer be redeemed after this date has elapsed. null if this discount can be redeemed forever.
Expired discounts can't be redeemed against transactions or checkouts, but can be applied when updating subscriptions.
Your own structured key-value data.
How many times this discount has been redeemed. Automatically incremented by Paddle.
Paddle counts a usage as a redemption on a checkout, transaction, or subscription. Transactions created for subscription renewals, midcycle changes, and one-time charges aren't considered a redemption.
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
Import information for this entity. null if this entity is not imported.
Information about this response.
Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
1234567891{
2 "description": "Seasonal sale",
3 "type": "percentage",
4 "amount": "10",
5 "enabled_for_checkout": true,
6 "recur": true,
7 "maximum_recurring_intervals": 3,
8 "expires_at": "2024-12-03T00:00:00Z"
9}