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.

event_idstring

Unique Paddle ID for this event, prefixed with evt_.

event_typestring

Type of event sent by Paddle, in the format entity.event_type.

occurred_atstring<date-time>

RFC 3339 datetime string of when this event occurred.

dataobject

New or changed entity.

idstring

Unique Paddle ID for this discount, prefixed with dsc_.

statusstring

Whether this entity can be used in Paddle.

descriptionstring

Short description for this discount for your reference. Not shown to customers.

enabled_for_checkoutboolean

Whether this discount can be redeemed by customers at checkout (true) or not (false).

codestring or null

Unique code that customers can use to redeem this discount at checkout. Not case-sensitive.

typestring

Type of discount. Determines how this discount impacts the checkout or transaction total.

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.

currency_codestring 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 subscription billing periods (true) or not (false).

maximum_recurring_intervalsinteger or null

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.

usage_limitinteger or null

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.

restrict_toarray[string] or null

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.

custom_dataobject or null

Your own structured key-value data.

import_metaobject or null

Import information for this entity. null if this entity is not imported.

expires_atstring<date-time> or null

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.

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.

notification_idstring

Unique Paddle ID for this notification, prefixed with ntf_.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
1{
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,