Subscription Payment Succeeded

Fired when a payment for a subscription is received successfully.

object

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

balance_earnings

string

Amount of balance increase as a result of this payment.

balance_fee

string

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

balance_gross

string

The total amount received from the customer as a result of the payment, in the vendor’s default currency at the time of the transaction.

balance_tax

string

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

country

object

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

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.

customer_name

string

The name of the customer (if collected).

earnings

string

The total amount (after taxes and fees) you earned from this payment.

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

string

The total amount in Paddle fees for this payment.

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

next_bill_date

string

The date the next payment is due on this subscription.

next_payment_amount

string

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

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 Pass Parameters documentation for more information.

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.

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.

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

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.