Subscription Payment Refunded

Fired when a refund for a subscription payment is issued.

object

Identify this event with the HTTP POST parameter alert_name with a value of subscription_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. Decimal value sent as a string.

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 earnings as a result of this refund, in the vendor’s default 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%).

balance_fee_refund
string

The fee amount returned to the vendor, in the vendor’s default 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 default currency at the time of the transaction.

balance_tax_refund
string

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

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.

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

The email address of the customer.

1 validation
event_time
string

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

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

The value of this field indicates whether it is the customer’s first payment for this subscription.

1 validation
instalments
string

Number of payments made to date. Integer sent as string.

marketing_consent
string

The value of this field 1 or 0 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.

passthrough
string

This field contains any values that you passed into the checkout using the passthrough parameter. See the Paddle Checkout (Web) documentation for more information.

quantity
string

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

1 validation
refund_type
string

The type of refund.

1 validation
status
string

This is the current status of the subscription. A list of possible values and their meanings can be found under Event Statuses.

1 validation
subscription_id
string

This is the unique Subscription ID for this customer’s subscription. You should 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.

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

p_signature
string

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