Payment Succeeded

Payment Succeeded
alert_name
string

The alert name.

Default:
payment_succeeded
alert_id
string

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

Match pattern:
\d+
balance_currency
string

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

Match pattern:
[A-Z]{3}
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.

Match pattern:
^\d+(\.\d{1,2})?$
balance_fee
string

The fee amount taken from the vendor, in the vendor’s balance_currency at the time of the transaction.

Match pattern:
^\d+(\.\d{1,2})?$
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.

Match pattern:
^\d+(\.\d{1,2})?$
balance_tax
string

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

Match pattern:
^\d+(\.\d{1,2})?$
checkout_id
string

The checkout id of the order created.

Example:
27835673-chre93c81118fc7-b3092639c1
country
string

The two-letter ISO country code of the customer. Eg: US, GB. See Supported Countries.

Match pattern:
[A-Z]{2}
coupon
string

The coupon code that was used on this order

>= 5 characters<= 300 characters
currency
string

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

Match pattern:
[A-Z]{3}
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.

Match pattern:
^\d+(\.\d{1,2})?$
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).

Match pattern:
[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) (2[0-3]|[01][0-9]):[0-5][0-9]:[0-5][0-9]
fee
string

The fee taken by Paddle for this payment.

Match pattern:
^\d+(\.\d{1,2})?$
ip
string

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

marketing_consent
integer

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

Allowed values:
01
order_id
string

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

Match pattern:
^\d+(-\d+)?
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.

<= 1000 characters
payment_method
string

Payment method used to make the transaction.

Allowed values:
cardpaypalfreeapple-paywire-transfer
payment_tax
string

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

Match pattern:
^\d+(\.\d{1,2})?$
product_id
string

The dashboard ID of the product purchased in this order.

Match pattern:
\d+
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.

Match pattern:
\d+
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.

Match pattern:
^\d+(\.\d{1,2})?$
used_price_override
string

Whether the dashboard price was overridden.

Allowed values:
truefalse
p_signature
string

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