Subscription Payment Refunded

Summary

A subscription_payment_refunded event is fired when a refund for an existing subscription is issued.

Payload

Information sent in the payload for a subscription_payment_refunded 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: subscription_payment_refunded
amount	string	The amount refunded, partial refunds are possible. Decimal value sent as a string.
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_decrease	string	The amount of revenue taken from the vendor’s balance as a result of this refund, in the vendor’s balance_currency at the time of the transaction. It returns a positive or negative value. For example, if you issue a VAT-only refund, this increases the vendor’s earnings instead of decreasing them; to reflect this we use a negative value. Also note that if the earnings of the order being refunded are split between vendors, the decreased amount will not include the other vendor’s fee - only yours. So: if you are giving 15% of your earnings to another vendor and keeping 85%, your balance earnings are reduced only by 85%).
balance_fee_refund	string	The fee amount returned to the vendor, in the vendor’s balance_currency at the time of the transaction.
balance_gross_refund	string	The total amount returned to the customer as a result of this refund, in the vendor’s balance_currency at the time of the transaction.
balance_tax_refund	string	The amount of tax returned to 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
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}
earnings_decrease	string	The amount of revenue taken from the vendor’s earnings as a result of this refund, in the currency of the original transaction. It returns a positive or negative value. E.g: if you issue a VAT-only refund, this will increase the vendor’s earnings instead of decreasing it, to reflect this we use a negative value. Please also note that if the earnings of the order being refunded are being split between vendors, the earnings decrease amount will not include the other vendor’s fee, only yours: for example if you are giving 15% of your earnings to another vendor and keeping 85%, your balance earnings will only be reduced by 85%.
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_refund	string	The fee amount returned to the vendor, in the currency of the original transaction.
gross_refund	string	The total amount returned to the customer as a result of this refund, in the currency of the original transaction.
initial_payment	integer	The value of this field 0 or 1 indicates whether it is the customer’s first payment for this subscription. Allowed values: 0 1
instalments	string	Number of payments made to date, starting from 1 for the customer's first payment. Integer sent as string.
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 Seller 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
quantity	string	The number of products or subscription seats sold in the transaction.
refund_reason	string	Refund reason note.
refund_type	string	The type of refund. Allowed values: full vat partial
status	string	This is the current status of the subscription. A list of possible values and their meanings can be found under Event Statuses. Allowed values: active trialing past_due paused deleted
subscription_id	string	This is the unique Subscription ID for this customer’s subscription. Store this with the customer in your database, as it is needed for making API calls.
subscription_payment_id	string	The unique ID of the subscription payment.
subscription_plan_id	string	The ID of the Subscription Plan the customer is subscribed to. (This is the value that will change upon plan change).
tax_refund	string	The amount of tax returned to the customer, in the currency of the original transaction.
unit_price	string	The price per unit of the subscription.
user_id	string	The customer user ID.