Subscription Payment Succeeded

Fired when a subscription payment is received successfully.

object

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

alert_name
string

The alert name.

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 account balance at the time of the transaction. Eg: USD, GBP, EUR.

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

1 validation
balance_fee
string

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

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

1 validation
balance_tax
string

The amount of tax received from 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
country
string

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

1 validation
coupon
string

The coupon code that was used on this order

2 validations
currency
string

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

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

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

1 validation
initial_payment
integer

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

1 validation
instalments
string

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

1 validation
marketing_consent
integer

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

1 validation
next_bill_date
string

The date the next payment is due on this subscription.

2 validations
next_payment_amount
string

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

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

Amount of tax paid as a result of this payment.

1 validation
plan_name
string

Subscription plan name.

quantity
string

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

1 validation
receipt_url
string

URL containing the customer receipt.

1 validation
sale_gross
string

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

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.

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

1 validation
unit_price
string

The price per unit of the subscription.

1 validation
user_id
string

The customer user ID.

1 validation
p_signature
string

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