Subscription Payment Failed

Fired when a payment for a subscription fails.

object

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

alert_name
string
1 validation
alert_id
string

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

1 validation
amount
string

The amount that we tried to charge for this payment. Decimal value sent as a string.

cancel_url
string

A URL of the ‘Cancellation’ page. See the documentation for update / cancellation URLs. You should store this URL along with the subscribed customer in your database.

checkout_id
string

The checkout id of the order created.

1 validation
currency
string

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

email
string

The email address of the customer.

1 validation
event_time
string

The date and time the event was triggered

1 validation
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_retry_date
string

The date that we will next try to process this failed payment.

1 validation
passthrough
string

This field contains any values that you passed into the checkout using the passthrough parameter. See the Paddle Checkout (Web) documentation for more information.

quantity
string

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

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.

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.

update_url
string

A URL of the ‘Update Billing Information’ page. See the documentation for update / cancellation URLs. You should store this URL along with the subscribed customer in your database.

subscription_payment_id
string

The unique ID of the subscription payment

1 validation
instalments
string

Number of payments made to date. Integer sent as string.

order_id
string

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

user_id
string

The customer user id.

attempt_number
string

Number of failed payment attempts made so far for this instalment. This number will reset back to 1 if the “Reset Attempts” button in the subscription management page is clicked.

1 validation
p_signature
string

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