Payment Refunded

Fired when a payment is refunded.

object

Identify this event with the HTTP POST parameter alert_name with a value of payment_refunded

alert_name
string
1 validation
alert_id
string

The unique identifier for this Paddle webhook alert. Integer value sent as a string.

1 validation
amount
string

The amount refunded, partial refunds are possible.

1 validation
balance_currency
string

The three letter ISO currency code of the vendor’s default currency at the time of the transaction. Eg: USD, GBP.

1 validation
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. Eg: 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. (eg. If you are giving 15% of your earnings to another vendor and keeping 85%, your balance earnings will be reduced only by 85%).

1 validation
balance_fee_refund
string

The fee amount returned to the vendor, in the vendor’s balance_currency at the time of the transaction.

1 validation
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.

1 validation
balance_tax_refund
string

The amount of tax returned to the customer, in the vendor’s balance_currency at the time of the transaction.

1 validation
checkout_id
string

The checkout id of the order created.

1 validation
currency
string

The three-letter ISO currency code. Eg: USD, GBP. See Supported Currencies.

1 validation
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%.

1 validation
email
string

The email address of the customer.

1 validation
event_time
string

The date and time the event was triggered in UTC (Coordinated Universal Time).

2 validations
fee_refund
string

The fee amount returned to the vendor, in the currency of the original transaction.

1 validation
gross_refund
string

The total amount returned to the customer as a result of this refund, in the currency of the original transaction.

1 validation
marketing_consent
string

The value of this field 0 or 1 indicates whether the user has agreed to receive marketing messages from the vendor.

1 validation
order_id
string

The Paddle Order ID for this payment. This can be used to look up the order within your Seller Dashboard.

1 validation
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.

1 validation
quantity
string

The number of products or subscription seats sold in the transaction.

1 validation
refund_reason
string

Refund reason note.

refund_type
string

The type of refund.

1 validation
tax_refund
string

The amount of tax returned to the customer, in the currency of the original transaction.

1 validation
p_signature
string

This field contains an encrypted token that you can use to verify the request authenticity. See Verifying Webhooks.