logo
Get Started
Guides
APIs
Webhooks
Reference
No results found.
Introduction
Security
Verifying Webhooks
Fulfillment Webhook
get/post
Subscription Created
post
Subscription Updated
post
Subscription Cancelled
post
Subscription Payment Succeeded
post
Subscription Payment Failed
post
Subscription Payment Refunded
post
Payment Succeeded
post
Payment Refunded
post
Order Processing Completed
post
Payment Dispute Created
post
Payment Dispute Closed
post
High Risk Transaction Created
post
High Risk Transaction Updated
post
Transfer Created
post
Transfer Paid
post
New Audience Member
post
Update Audience Member
post
Invoice Paid
post
Invoice Sent
post
Invoice Overdue
post

Subscription Cancelled

Fired when an existing subscription is cancelled.

object

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

alert_name
string
1 validation
alert_id
string

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

1 validation
cancellation_effective_date
string

The date the cancellation should come into effect, taking the customer’s most recent payment into account. The customer should be able to use the service they’ve subscribed to up until this date.

2 validations
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.

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

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.