> For the complete documentation index, see [llms.txt](https://developer.paddle.com/llms.txt). # discount.imported Occurs when a discount is imported. --- Occurs when a discount is imported. 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](https://developer.paddle.com/api-reference/discounts/get-discount) to see the latest value. ## Schema ```json { "type": "object", "required": [ "event_id", "event_type", "occurred_at", "notification_id", "data" ], "properties": { "event_id": { "type": "string", "pattern": "^evt_[a-z\\d]{26}$", "description": "Unique Paddle ID for this event, prefixed with `evt_`.", "title": "Event ID", "examples": [ "evt_01gks14ge726w50ch2tmaw2a1x" ] }, "event_type": { "type": "string", "enum": [ "address.created", "address.imported", "address.updated", "adjustment.created", "adjustment.updated", "api_key.created", "api_key.expired", "api_key.expiring", "api_key.revoked", "api_key.updated", "api_key_exposure.created", "business.created", "business.imported", "business.updated", "client_token.created", "client_token.revoked", "client_token.updated", "customer.created", "customer.imported", "customer.updated", "discount.created", "discount.imported", "discount.updated", "discount_group.created", "discount_group.updated", "payment_method.saved", "payment_method.deleted", "payout.created", "payout.paid", "price.created", "price.imported", "price.updated", "product.created", "product.imported", "product.updated", "report.created", "report.updated", "subscription.activated", "subscription.canceled", "subscription.created", "subscription.imported", "subscription.past_due", "subscription.paused", "subscription.resumed", "subscription.trialing", "subscription.updated", "transaction.billed", "transaction.canceled", "transaction.completed", "transaction.created", "transaction.paid", "transaction.past_due", "transaction.payment_failed", "transaction.ready", "transaction.revised", "transaction.updated" ], "description": "Type of event sent by Paddle, in the format `entity.event_type`.", "title": "Event type name", "x-enum-descriptions": { "address.created": { "description": "An [`address.created`](https://developer.paddle.com/webhooks/addresses/address-created) event." }, "address.imported": { "description": "An [`address.imported`](https://developer.paddle.com/webhooks/addresses/address-imported) event." }, "address.updated": { "description": "An [`address.updated`](https://developer.paddle.com/webhooks/addresses/address-updated) event." }, "adjustment.created": { "description": "An [`adjustment.created`](https://developer.paddle.com/webhooks/adjustments/adjustment-created) event." }, "adjustment.updated": { "description": "An [`adjustment.updated`](https://developer.paddle.com/webhooks/adjustments/adjustment-updated) event." }, "api_key.created": { "description": "An [`api_key.created`](https://developer.paddle.com/webhooks/api-keys/api-key-created) event." }, "api_key.expired": { "description": "An [`api_key.expired`](https://developer.paddle.com/webhooks/api-keys/api-key-expired) event." }, "api_key.expiring": { "description": "An [`api_key.expiring`](https://developer.paddle.com/webhooks/api-keys/api-key-expiring) event." }, "api_key.revoked": { "description": "An [`api_key.revoked`](https://developer.paddle.com/webhooks/api-keys/api-key-revoked) event." }, "api_key.updated": { "description": "An [`api_key.updated`](https://developer.paddle.com/webhooks/api-keys/api-key-updated) event." }, "api_key_exposure.created": { "description": "An [`api_key_exposure.created`](https://developer.paddle.com/webhooks/api-key-exposures/api-key-exposure-created) event." }, "business.created": { "description": "A [`business.created`](https://developer.paddle.com/webhooks/businesses/business-created) event." }, "business.imported": { "description": "A [`business.imported`](https://developer.paddle.com/webhooks/businesses/business-imported) event." }, "business.updated": { "description": "A [`business.updated`](https://developer.paddle.com/webhooks/businesses/business-updated) event." }, "client_token.created": { "description": "A [`client_token.created`](https://developer.paddle.com/webhooks/client-tokens/client-token-created) event." }, "client_token.revoked": { "description": "A [`client_token.revoked`](https://developer.paddle.com/webhooks/client-tokens/client-token-revoked) event." }, "client_token.updated": { "description": "A [`client_token.updated`](https://developer.paddle.com/webhooks/client-tokens/client-token-updated) event." }, "customer.created": { "description": "A [`customer.created`](https://developer.paddle.com/webhooks/customers/customer-created) event." }, "customer.imported": { "description": "A [`customer.imported`](https://developer.paddle.com/webhooks/customers/customer-imported) event." }, "customer.updated": { "description": "A [`customer.updated`](https://developer.paddle.com/webhooks/customers/customer-updated) event." }, "discount.created": { "description": "A [`discount.created`](https://developer.paddle.com/webhooks/discounts/discount-created) event." }, "discount.imported": { "description": "A [`discount.imported`](https://developer.paddle.com/webhooks/discounts/discount-imported) event." }, "discount.updated": { "description": "A [`discount.updated`](https://developer.paddle.com/webhooks/discounts/discount-updated) event." }, "discount_group.created": { "description": "A [`discount_group.created`](https://developer.paddle.com/webhooks/discount-groups/discount-group-created) event." }, "discount_group.updated": { "description": "A [`discount_group.updated`](https://developer.paddle.com/webhooks/discount-groups/discount-group-updated) event." }, "payment_method.saved": { "description": "A [`payment_method.saved`](https://developer.paddle.com/webhooks/payment-methods/payment-method-saved) event." }, "payment_method.deleted": { "description": "A [`payment_method.deleted`](https://developer.paddle.com/webhooks/payment-methods/payment-method-deleted) event." }, "payout.created": { "description": "A [`payout.created`](https://developer.paddle.com/webhooks/payouts/payout-created) event." }, "payout.paid": { "description": "A [`payout.paid`](https://developer.paddle.com/webhooks/payouts/payout-paid) event." }, "price.created": { "description": "A [`price.created`](https://developer.paddle.com/webhooks/prices/price-created) event." }, "price.imported": { "description": "A [`price.imported`](https://developer.paddle.com/webhooks/prices/price-imported) event." }, "price.updated": { "description": "A [`price.updated`](https://developer.paddle.com/webhooks/prices/price-updated) event." }, "product.created": { "description": "A [`product.created`](https://developer.paddle.com/webhooks/products/product-created) event." }, "product.imported": { "description": "A [`product.imported`](https://developer.paddle.com/webhooks/products/product-imported) event." }, "product.updated": { "description": "A [`product.updated`](https://developer.paddle.com/webhooks/products/product-updated) event." }, "report.created": { "description": "A [`report.created`](https://developer.paddle.com/webhooks/reports/report-created) event." }, "report.updated": { "description": "A [`report.updated`](https://developer.paddle.com/webhooks/reports/report-updated) event." }, "subscription.activated": { "description": "A [`subscription.activated`](https://developer.paddle.com/webhooks/subscriptions/subscription-activated) event." }, "subscription.canceled": { "description": "A [`subscription.canceled`](https://developer.paddle.com/webhooks/subscriptions/subscription-canceled) event." }, "subscription.created": { "description": "A [`subscription.created`](https://developer.paddle.com/webhooks/subscriptions/subscription-created) event." }, "subscription.imported": { "description": "A [`subscription.imported`](https://developer.paddle.com/webhooks/subscriptions/subscription-imported) event." }, "subscription.past_due": { "description": "A [`subscription.past_due`](https://developer.paddle.com/webhooks/subscriptions/subscription-past-due) event." }, "subscription.paused": { "description": "A [`subscription.paused`](https://developer.paddle.com/webhooks/subscriptions/subscription-paused) event." }, "subscription.resumed": { "description": "A [`subscription.resumed`](https://developer.paddle.com/webhooks/subscriptions/subscription-resumed) event." }, "subscription.trialing": { "description": "A [`subscription.trialing`](https://developer.paddle.com/webhooks/subscriptions/subscription-trialing) event." }, "subscription.updated": { "description": "A [`subscription.updated`](https://developer.paddle.com/webhooks/subscriptions/subscription-updated) event." }, "transaction.billed": { "description": "A [`transaction.billed`](https://developer.paddle.com/webhooks/transactions/transaction-billed) event." }, "transaction.canceled": { "description": "A [`transaction.canceled`](https://developer.paddle.com/webhooks/transactions/transaction-canceled) event." }, "transaction.completed": { "description": "A [`transaction.completed`](https://developer.paddle.com/webhooks/transactions/transaction-completed) event." }, "transaction.created": { "description": "A [`transaction.created`](https://developer.paddle.com/webhooks/transactions/transaction-created) event." }, "transaction.paid": { "description": "A [`transaction.paid`](https://developer.paddle.com/webhooks/transactions/transaction-paid) event." }, "transaction.past_due": { "description": "A [`transaction.past_due`](https://developer.paddle.com/webhooks/transactions/transaction-past-due) event." }, "transaction.payment_failed": { "description": "A [`transaction.payment_failed`](https://developer.paddle.com/webhooks/transactions/transaction-payment-failed) event." }, "transaction.ready": { "description": "A [`transaction.ready`](https://developer.paddle.com/webhooks/transactions/transaction-ready) event." }, "transaction.revised": { "description": "A [`transaction.revised`](https://developer.paddle.com/webhooks/transactions/transaction-revised) event." }, "transaction.updated": { "description": "A [`transaction.updated`](https://developer.paddle.com/webhooks/transactions/transaction-updated) event." } } }, "occurred_at": { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string of when this event occurred.", "title": "Timestamp", "examples": [ "2024-10-12T07:20:50.52Z" ] }, "notification_id": { "type": "string", "pattern": "^ntf_[a-z\\d]{26}$", "description": "Unique Paddle ID for this notification, prefixed with `ntf_`.", "title": "Notification ID", "examples": [ "ntf_01ghbkd0frb9k95cnhwd1bxpvk" ] }, "data": { "properties": { "id": { "type": "string", "pattern": "^dsc_[a-z\\d]{26}$", "description": "Unique Paddle ID for this discount, prefixed with `dsc_`.", "title": "Discount ID", "examples": [ "dsc_01gv5kpg05xp104ek2fmgjwttf" ] }, "status": { "type": "string", "enum": [ "active", "archived" ], "description": "Whether this entity can be used in Paddle.", "x-enum-descriptions": { "active": { "description": "Entity is active and can be used." }, "archived": { "description": "Entity is archived, so can't be used." }, "expired": { "description": "Discount has expired. Automatically set by Paddle when the `expires_at` date elapses.\n\nExpired discounts can't be redeemed against transactions or checkouts, but can be applied when updating subscriptions." }, "used": { "description": "Discount has reached the maximum amount of redemptions. Automatically set by Paddle when the `usage_limit` is reached.\n\nUsed discounts can't be redeemed against transactions or checkouts, but can be applied when updating subscriptions." } } }, "description": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Short description for this discount for your reference. Not shown to customers." }, "enabled_for_checkout": { "type": "boolean", "description": "Whether this discount can be redeemed by customers at checkout (`true`) or not (`false`)." }, "code": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 32, "pattern": "^[a-zA-Z0-9]{1,32}$", "description": "Unique code that customers can use to apply this discount at checkout. Use letters and numbers only, up to 32 characters. Not case-sensitive.", "title": "Discount code" }, { "type": "null" } ], "minLength": 1, "maxLength": 32, "pattern": "^[a-zA-Z0-9]{1,32}$" }, "type": { "type": "string", "enum": [ "flat", "flat_per_seat", "percentage" ], "description": "Type of discount. Determines how this discount impacts the checkout or transaction total.", "title": "DiscountType", "x-enum-descriptions": { "flat": { "description": "Discounts a checkout or transaction by a flat amount, for example -$100. Requires `currency_code`." }, "flat_per_seat": { "description": "Discounts a checkout or transaction by a flat amount per unit, for example -$100 per user. Requires `currency_code`." }, "percentage": { "description": "Discounts a checkout or transaction by a percentage of the total, for example -10%. Maximum 100%." } } }, "amount": { "type": "string", "description": "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_code": { "anyOf": [ { "type": "string", "enum": [ "USD", "EUR", "GBP", "JPY", "AUD", "CAD", "CHF", "HKD", "SGD", "SEK", "ARS", "BRL", "CLP", "CNY", "COP", "CZK", "DKK", "HUF", "ILS", "INR", "KRW", "MXN", "NOK", "NZD", "PEN", "PLN", "RUB", "THB", "TRY", "TWD", "UAH", "VND", "ZAR" ], "description": "Supported three-letter ISO 4217 currency code.", "title": "Currency code", "x-enum-descriptions": { "USD": { "description": "United States Dollar" }, "EUR": { "description": "Euro" }, "GBP": { "description": "Pound Sterling" }, "JPY": { "description": "Japanese Yen" }, "AUD": { "description": "Australian Dollar" }, "CAD": { "description": "Canadian Dollar" }, "CHF": { "description": "Swiss Franc" }, "HKD": { "description": "Hong Kong Dollar" }, "SGD": { "description": "Singapore Dollar" }, "SEK": { "description": "Swedish Krona" }, "ARS": { "description": "Argentine Peso" }, "BRL": { "description": "Brazilian Real" }, "CLP": { "description": "Chilean Peso" }, "CNY": { "description": "Chinese Yuan" }, "COP": { "description": "Colombian Peso" }, "CZK": { "description": "Czech Koruna" }, "DKK": { "description": "Danish Krone" }, "HUF": { "description": "Hungarian Forint" }, "ILS": { "description": "Israeli Shekel" }, "INR": { "description": "Indian Rupee" }, "KRW": { "description": "South Korean Won" }, "MXN": { "description": "Mexican Peso" }, "NOK": { "description": "Norwegian Krone" }, "NZD": { "description": "New Zealand Dollar" }, "PEN": { "description": "Peruvian Sol" }, "PLN": { "description": "Polish Zloty" }, "RUB": { "description": "Russian Ruble" }, "THB": { "description": "Thai Baht" }, "TRY": { "description": "Turkish Lira" }, "TWD": { "description": "New Taiwan Dollar" }, "UAH": { "description": "Ukrainian Hryvnia" }, "VND": { "description": "Vietnamese Dong" }, "ZAR": { "description": "South African Rand" } } }, { "type": "null" } ] }, "recur": { "type": "boolean", "description": "Whether this discount applies for multiple subscription billing periods (`true`) or not (`false`)." }, "maximum_recurring_intervals": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "minimum": 1, "description": "Number of subscription billing periods that this discount recurs for. Requires `recur`. `null` if this discount recurs forever.\n\nSubscription 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_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "minimum": 1, "description": "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.\n\nPaddle 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_to": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^(pri|pro)_[a-z\\d]{26}$" } }, { "type": "null" } ], "maxItems": 50, "description": "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.", "uniqueItems": true }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string.", "title": "Timestamp", "examples": [ "2024-10-12T07:20:50.52Z" ] }, { "type": "null" } ] }, "mode": { "anyOf": [ { "type": "string", "enum": [ "standard", "custom" ], "description": "Discount mode. Standard discounts are considered part of your catalog and are shown in the Paddle dashboard.", "title": "DiscountMode", "x-enum-descriptions": { "custom": { "description": "Non-catalog discount. Can be created via the API, or by Paddle for checkout recovery discounts. Not returned when listing or shown in the Paddle dashboard." }, "standard": { "description": "Standard discount. Can be considered part of your catalog and reused across transactions and subscriptions easily." } } }, { "type": "null" } ] }, "discount_group_id": { "anyOf": [ { "type": "string", "pattern": "^dsg_[a-z\\d]{26}$", "description": "Unique Paddle ID for this discount group, prefixed with `dsg_`.", "title": "Discount Group ID", "examples": [ "dsg_01js2gqehzccfkywgx1jk2mtsp" ] }, { "type": "null" } ], "pattern": "^dsg_[a-z\\d]{26}$", "examples": [ "dsg_01js2gqehzccfkywgx1jk2mtsp" ] }, "custom_data": { "anyOf": [ { "type": "object", "unevaluatedProperties": {}, "description": "Your own structured key-value data.", "title": "Custom Data", "example": { "customer_reference_id": "abcd1234" } }, { "type": "null" } ] }, "import_meta": { "anyOf": [ { "type": "object", "required": [ "imported_from" ], "properties": { "external_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200, "description": "Reference or identifier for this entity from the provider where it was imported from.", "title": "External ID", "examples": [ "9b95b0b8-e10f-441a-862e-1936a6d818ab" ] }, { "type": "null" } ] }, "imported_from": { "type": "string", "minLength": 1, "maxLength": 200, "description": "Name of the platform or provider where this entity was imported from.", "examples": [ "paddle_classic" ] } }, "description": "Import information for this entity. `null` if this entity is not imported.", "title": "ImportMeta" }, { "type": "null" } ] }, "created_at": { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.", "title": "Created at", "examples": [ "2024-10-12T07:20:50.52Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.", "title": "Updated at", "examples": [ "2024-10-13T07:20:50.52Z" ] } }, "required": [ "id", "status", "description", "enabled_for_checkout", "code", "type", "amount", "currency_code", "recur", "maximum_recurring_intervals", "usage_limit", "restrict_to", "expires_at", "mode", "discount_group_id", "custom_data", "import_meta", "created_at", "updated_at" ], "type": "object", "description": "New or changed entity." } } } ``` ## Example ```json { "event_id": "evt_01hdnnd4x84s4r5br068y3rm6d", "event_type": "discount.imported", "occurred_at": "2025-06-12T09:35:17.929027Z", "notification_id": "ntf_01hdnnd505rcs80ss56rfn7qa2", "data": { "id": "dsc_01gv599b6zkj42fkpxftjeca8f", "description": "Legacy customer discount", "code": "ZJFYC3K9KT", "type": "flat", "amount": "1000", "currency_code": "USD", "mode": "standard", "status": "active", "discount_group_id": null, "recur": true, "maximum_recurring_intervals": null, "usage_limit": null, "restrict_to": [ "pri_01h19fp7wgbasj0h1627jknp7f" ], "enabled_for_checkout": true, "expires_at": "2027-06-12T09:18:00Z", "created_at": "2023-03-10T08:13:06.655Z", "updated_at": "2023-06-05T09:18:46.63Z", "custom_data": null, "import_meta": { "external_id": "fc1ba9bc-8ddb-11ee-b9d1-0242ac120002", "imported_from": "paddle_classic" } } } ```