Payment Succeeded

Fired when a payment is made into your Paddle account.

object

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

alert_name
string
1 validation
alert_id
string

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

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
string

The amount credited to your balance in your default currency.

1 validation
balance_fee
string

The fees taken by Paddle in your dashboard balance currency.

1 validation
balance_gross
string

The sale value in your dashboard balance currency.

1 validation
balance_tax
string

The amount paid in tax in your dashboard balance currency.

1 validation
checkout_id
string

The checkout id of the order created.

1 validation
country
string

The two letter ISO country code of the customer. Eg: US, GB.

1 validation
coupon
string

The coupon code that was used on this order

currency
string

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

1 validation
customer_name
string

The name of the customer this payment is from (if collected).

earnings
string

The amount of this payment that was credited to your balance.

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
string

The fee taken by Paddle for this payment.

1 validation
ip
string

This field is deprecated and will be removed in a future update.

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.

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
payment_method
string

Payment method used to make the transaction.

1 validation
payment_tax
string

The amount of this payment that was paid in tax/VAT.

1 validation
product_id
string

The dashboard ID of the product purchased in this order.

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

1 validation
receipt_url
string

A URL where the receipt for the transaction can be retrieved.

1 validation
sale_gross
string

The total value of the sale (including tax) in the sale currency.

1 validation
used_price_override
string

Whether the dashboard price was overridden.

1 validation
p_signature
string

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