Subscription Updated

Fired when the plan, price, quantity, state or payment date of a subscription changes.

object

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

alert_name

string

1 validation

alert_id

string

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

1 validation

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

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

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

new_price

string

The new total recurring price of the subscription. Please note that this will only be returned if the subscription has quantity enabled. Decimal sent as a string.

new_quantity

string

The new quantity applied to a quantity enabled subscription. Please note that this will only be returned if the subscription has quantity enabled.

1 validation

new_unit_price

string

The new price per unit of the subscription. Please note that this will only be returned if the subscription has quantity enabled. Decimal sent as a string.

next_bill_date

string

The date the next payment is due on this subscription.

old_price

string

The previous total recurring price of the subscription. Decimal sent as a string.

old_quantity

string

The previous quantity applied to the subscription. Please note that this will only be returned if the subscription has quantity enabled.

1 validation

old_unit_price

string

The previous price per unit of the subscription. Please note that this will only be returned if the subscription has quantity enabled. Decimal sent as a string.

currency

string

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

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.

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

user_id

string

The customer user id.

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.

old_next_bill_date

string

The next bill date before the subscription was updated.

1 validation

old_status

string

The subscription state before the subscription was updated.

1 validation

old_subscription_plan_id

string

The ID of the subscription plan before the subscription was updated.

1 validation

p_signature

string

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

paused_at

string

The date & time when the subscription was requested to be paused.

1 validation

paused_from

string

The date when the subscription payment is paused.

1 validation