Subscription Payment Succeeded

Subscription Payment Succeeded
alert_name
string

The alert name.

Default:
subscription_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 total amount (after taxes and fees) you earned from this payment.

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 total amount in Paddle fees for this payment.

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

Number of payments made to date, starting from 1 for the customer's first payment. Integer sent as string.

Match pattern:
\d+
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
next_bill_date
string<date>

The date the next payment is due on this subscription.

Match pattern:
^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12][0-9]|3[01])$
next_payment_amount
string

The total amount that the customer will be charged for on their upcoming payment, in the subscription’s currency.

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

Amount of tax paid as a result of this payment.

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

Subscription plan name.

quantity
string

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

Match pattern:
\d+
receipt_url
string<uri>

URL containing the customer receipt.

sale_gross
string

The total amount the customer was charged for this payment. Decimal sent as string.

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

Match pattern:
\d+
subscription_payment_id
string

The unique ID of the subscription payment.

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

Match pattern:
\d+
unit_price
string

The price per unit of the subscription.

Match pattern:
(\d+\.\d{1,2})
user_id
string

The customer user ID.

Match pattern:
\d+
p_signature
string

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