Payment Succeeded

Summary

A payment_succeeded event is fired when a payment is made into your Paddle account.

Payload

Information sent in the payload for a payment_succeeded webhook is summarised in the table below.

Property	Type	Description	Example
alert_id	string	The unique identifier for this Paddle webhook alert. Integer value sent as a string.
alert_name	string	The alert name. Default: payment_succeeded
balance_currency	string	The three-letter ISO currency code of the vendor’s account balance at the time of the transaction.	USD GBP EUR
balance_earnings	string	The amount of revenue added to the vendor’s balance as a result of this payment, in the vendor’s balance_currency at the time of the transaction.
balance_fee	string	The fee amount taken from the vendor, in the vendor’s balance_currency at the time of the transaction.
balance_gross	string	The total amount received from the customer as a result of the payment, in the vendor’s balance_currency at the time of the transaction.
balance_tax	string	The amount of tax received from the customer, in the vendor’s balance_currency at the time of the transaction.
checkout_id	string	The checkout id of the order created.	27835673-chre93c81118fc7-b3092639c1
country	string	The two-letter ISO country code of the customer. For a full list of supported countries, see our Supported Countries page.	US GB
coupon	string	The coupon code that was used on this order. Min Length: >=5 characters Max Length: <=300 characters
currency	string	The three-letter ISO currency code. For a full list of supported currencies, see our Supported Currencies page.	USD GBP
custom_data	string	A JSON encoded string of custom data that was passed into the checkout for this purchase	{"external_id": 42}
customer_name	string	The name of the customer. For card payments, this will return the cardholder name entered by the buyer during the checkout. For PayPal payments, this will return the name from the PayPal account used during the checkout. For all other payment methods where the name is not collected (including Apple Pay and Wire Transfer), this will be empty.
earnings	string	The amount of this payment that was credited to your balance.
email	string<email>	The email address of the customer.
event_time	string<date-time>	The date and time the event was triggered in UTC (Coordinated Universal Time).
fee	string	The fee taken by Paddle for this payment.
ip	string	This field is deprecated and will be removed in a future update.
marketing_consent	string	The value of this field 0 or 1 indicates whether the user has agreed to receive marketing messages from the vendor. Allowed values: 0 1
order_id	string	The Paddle Order ID for this payment. This can be used to look up the order within your Vendor Dashboard.
p_signature	string	This field contains an encrypted token that you can use to verify the request authenticity. See Verifying Webhooks.
passthrough	string	This field contains any values that you passed into the checkout using the passthrough parameter. See the Pass Parameters documentation for more information. Max Length: <=1000 characters
payment_method	string	Payment method used to make the transaction. free card paypal wire-transfer apple-pay google-pay ideal alipay
payment_tax	string	The amount of this payment that was paid in tax/VAT.
product_id	string	The dashboard ID of the product purchased in this order.
product_name	string	The name of the product included in the transaction.
quantity	string	The number of products or subscription seats sold in the transaction.
receipt_url	string<uri>	A URL where the receipt for the transaction can be retrieved.
sale_gross	string	The total value of the sale (including tax) in the sale currency.
used_price_override	string	Determines whether the Dashboard price was overridden. Allowed values: 1 0