Paddle Billing
Ask AI

Discount reports

Generate detailed reports about discounts in your catalog, including their usage, status, and configuration.

Discounts let you reduce the amount a customer has to pay for a transaction. Discounts are sometimes called coupons or promo codes.

You can generate reports through the dashboard or via the API.

Report filters

When generating discount reports, you can filter by:

FieldDescription
Updated dateThe date a discount was last modified. Matches entities modified on or after the start date and before the end date.
Status

The current status of the discount.

  • Active: Discount is active and can be used.
  • Archived: Discount is archived, so can't be used.
  • Expired: Discount has expired. Automatically set by Paddle when the expires_at date elapses.
  • Used: Discount has reached the maximum amount of redemptions. Automatically set by Paddle when the usage_limit is reached.
Type

The kind of discount.

  • Flat: Discounts a transaction by a flat amount, for example -$100 off the total.
  • Flat per seat: Discounts a transaction by a flat amount per unit, for example -$100 each unit.
  • Percentage: Discounts a transaction by a percentage of the total, for example 10%.

Report columns

Column headings on discount reports mirror fields in the Paddle API. Data is provided in the following columns:

discount_idstring

Unique Paddle ID for this discount, prefixed with dsc_.

statusstring

Whether this entity can be used in Paddle.

typestring

Type of discount.

discount_amountstring

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.

discount_currencystring or null

Supported three-letter ISO 4217 currency code. Required where discount type is flat or flat_per_seat.

recurboolean

Whether this discount applies for multiple billing periods.

maximum_recurring_intervalsinteger or null

Amount of subscription billing periods that this discount recurs for. Requires recur. null if this discount recurs forever.

usage_limitinteger or null

Maximum amount of times this discount can be used. This is an overall limit, rather than a per-customer limit. null if this discount can be used an unlimited amount of times.

restrict_tostring

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.

expires_atstring<date-time> or null

RFC 3339 datetime string of when this discount expires. Discount can no longer be applied after this date has elapsed. null if this discount can be applied forever.

created_atstring<date-time>

RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.

updated_atstring<date-time>

RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.

Related pages

AI Assistant

Ask me about Paddle

Discover, integrate, and debug faster. I'm here to help with all your questions and use cases.

Looking for help with a purchase? Visit paddle.net.

Powered by kapa.ai
|
Protected by hCaptcha