Organize your discounts with discount groups
Manage your discounts more easily by creating discount groups and assigning them to discounts using the Paddle API.
What's new?
We've released the ability to create discount groups and assign them to discounts using the Paddle API.
Grouping discounts makes them more easily identifiable and easier to manage. For example, you may create groups for specific discounts targeted at:
- Marketing and new customer prospects that would be used by the marketing team.
- Retention or loyalty that would be used by customer service or operational teams.
- Seasonal promotions or campaigns like Black Friday or Cyber Monday.
How it works
Discounts let you reduce transaction totals by a percentage or a flat amount. You can create one-time or recurring discounts, set up codes for customers to use at checkout, restrict discounts to specific products, limit their usage, or set expiration dates for promotions.
Previously, you were unable to identify and group discounts together under the use, category, or purpose of that discount unless you passed custom data. With this change, you can:
Add a name to the discount group to easily identify the category, purpose, or other criteria that you use to group discounts.
Create or update a discount with the
discount_group_id
field matching theid
of a discount group. Discounts can only be assigned to one discount group at a time.Use the
discount_group_id
query parameter when listing discounts to filter discounts by their assigned discount group.
You can also use the:
- New
discount_group.created
webhook to get notified when a discount group is created. - Existing
discount.created
ordiscount.updated
to detect when a discount is assigned to a discount group by checking for thediscount_group_id
field.
Discount groups are only available in the Paddle API. They're coming to the dashboard at a later date.
Summary of changes
Fields
This is a summary of the changes to fields in the Paddle API and webhooks:
Field | Change | Notes |
---|---|---|
discount_group | New entity | Returned by discount group operations, includes, and webhooks. |
discount.discount_group_id | New field | Paddle ID of the discount group assigned to the discount, prefixed with dsg_ . |
API operations
This is a summary of new operations:
Method | Path | Summary |
---|---|---|
GET | /discount-groups | List discount groups |
POST | /discount-groups | Create a discount group |
Query parameters
This is a summary of changes to query parameters in the Paddle API:
Operation | Parameter | Change | Notes |
---|---|---|---|
List discounts | discount_group_id | New parameter | List discounts by their assigned discount group. |
List discounts | include | New parameter | Include the discount group in the response by providing a value of discount_group . |
Webhooks
This is a summary of new webhooks:
Event | Description |
---|---|
discount_group.created | Occurs when a discount group is created. |
Next steps
This change is available in version 1
of the Paddle API.
It's a non-breaking change, meaning it doesn't impact existing integrations.
Check out the discount group entity overview and our guide on creating and assigning groups to discounts to get started.