discount.created
Occurs when a discount is created.
Payload includes the complete discount entity, except times_used
. This field changes frequently, so isn't included in payloads. Get a discount using the API to see the latest value.
Unique Paddle ID for this event, prefixed with evt_
.
Type of event sent by Paddle, in the format entity.event_type
.
RFC 3339 datetime string of when this event occurred.
New or changed entity.
Unique Paddle ID for this discount, prefixed with dsc_
.
Whether this entity can be used in Paddle. expired
and used
are set automatically by Paddle.
Short description for this discount for your reference. Not shown to customers.
Whether this discount can be applied by a customer at checkout.
Unique code that customers can use to apply this discount at checkout. Use letters and numbers only, up to 16 characters. Paddle generates a random 10-character code if a code is not provided and enabled_for_checkout
is true
.
Type of discount.
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 billing periods.
Amount of subscription billing periods that this discount recurs for. Requires recur
. null
if this discount recurs forever.
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.
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.
Your own structured key-value data.
Import information for this entity. null
if this entity is not imported.
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.
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.
Unique Paddle ID for this notification, prefixed with ntf_
.
12345678910111213141516171819201{
2 "event_id": "evt_01hv6scz1kqjp8wx6ft1mc3kd2",
3 "event_type": "discount.created",
4 "occurred_at": "2024-04-11T14:36:15.283806Z",
5 "notification_id": "ntf_01hv6scz45nrn82tmkw4ywb71k",
6 "data": {
7 "id": "dsc_01hv6scyf7qdnzcdq01t2y8dx4",
8 "code": "SEWRGPB9WY",
9 "type": "percentage",
10 "recur": true,
11 "amount": "10",
12 "status": "active",
13 "created_at": "2024-04-11T14:36:14.695Z",
14 "expires_at": "2024-12-03T00:00:00Z",
15 "updated_at": "2024-04-11T14:36:14.695Z",
16 "custom_data": null,
17 "description": "Seasonal sale",
18 "import_meta": null,
19 "restrict_to": [],
20 "usage_limit": null,