Webhooks explained (V2) · Recharge API

Here you will find what specific action triggers a given webhook.

Address webhooks

To use these webhooks your API Token must have read permissions for Customers enabled ( read_customer ).

Topic	Explanation
`address/created`	This will trigger when you create an address via API, or when you go through the checkout with a particular address for the first time with the same customer.
`address/updated`	This will trigger when you update an address via API, or when you update the address via UI. It will also trigger whenever a subscription has been activated or cancelled.

Bundle webhooks

To use these webhooks your API Token must have read permissions for Subscriptions enabled ( read_subscriptions ).

Topic	Explanation
`bundle_selection/created`	This will trigger when a new selection is created for a Bundle subscription.
`bundle_selection/updated`	This will trigger when a Bundle Selection is succesfully updated.
`bundle_selection/deleted`	This will trigger when a Bundle Selection is deleted.

Charge webhooks

To use these webhooks your API Token must have read permissions for Orders enabled ( read_orders ).

Topic	Explanation
`charge/created`	This will trigger when a charge is created.
`charge/failed`	This will trigger every time we try to process a charge and it fails due to various reasons (insufficient funds, invalid CC info, expired CC, etc.) on both API and UI.
`charge/max_retries_reached`	This will trigger after we attempt to process a charge 8 times, and it failed every time due to various CC issues. This can be triggered on both UI (manually retry a charge 8 times and fail) and API.
`charge/paid`	This will trigger when a charge is successfully processed, both manually via UI and automatic recurring charge. This will not trigger on the checkout itself.
`charge/refunded`	This will trigger when a charge is successfully refunded, either partially or in full. It will fire if a charge has been refunded both manually via UI and through an API request.
`charge/upcoming`	This will trigger X days before the upcoming charge is scheduled. The default is 3 days but your store specific setting can be verified on the Notification Settings page in the description of the Upcoming charge customer notification.
`charge/updated`	This will trigger when applying a discount, a change to charge that recalculates shipping rates as well as if next_charge_date is updated on charge endpoint charges/<charge_id>/change_next_charge_date.
`charge/deleted`	This will trigger when a subscription is cancelled and upcoming charges are deleted.

Checkout webhooks

To use these webhooks your API Token must have read permissions for Orders enabled ( read-orders ).

Topic	Explanation
`checkout/created`	This will trigger when a checkout is successfully created.
`checkout/completed`	Will be deprecated.
`checkout/processed`	This will trigger when a checkout is successfully processed.
`checkout/updated`	This will trigger when a checkout is successfully updated.

Customer webhooks

To use these webhooks your API Token must have read permissions for Customers enabled ( read_customers ).

Topic	Explanation
`customer/activated`	This will trigger when you activate* a customer * activating means that you have added a subscription to a customer who didn’t have an active subscription previously.
`customer/created`	This will trigger when you create a customer via API or go through the checkout with a particular email address for a first time customer.
`customer/deactivated`	This will trigger when the last subscription a customer had expires, so he no longer has ANY active subscriptions (which means there are no QUEUED charges/orders for this customer).
`customer/payment_method_updated`	This will trigger only* when you update the payment_token from the UI * We are working on triggering this when you do the update from the API as well.
`customer/updated`	This will trigger when you update a customer via both API and UI.
`customer/deleted`	This will trigger when you delete a customer via both API and UI.

Gift Purchase webhooks

To use these webhooks your API Token must have read permissions for Gifts enabled ( read_gift_purchases ).

Topic	Explanation
`gift_purchase/created`	This will trigger when a gift purchase record is created, typically via a gift item purchased.
`gift_purchase/redeemed`	This will trigger when a gift product is redeemed by the gift receiver.

Onetime webhooks

To use these webhooks your API Token must have read permissions for Subscriptions enabled ( read_subscriptions ).

Topic	Explanation
`onetime/created`	This will trigger when you create a one time product via API.
`onetime/deleted`	This will trigger when you delete a one time product via API.
`onetime/updated`	This will trigger when you update a one time product via API.

Order webhooks

To use these webhooks your API Token must have read permissions for Orders enabled ( read_orders ).

Topic	Explanation
`order/created`	This will trigger when an order is created (when a charge is successfully processed) * In case of prepaid Orders the order/created webhooks will be fired for each prepaid order that is created. This occurs on the date the order is scheduled at.
`order/deleted`	This will trigger when an order is deleted.
`order/processed`	This will trigger when the order is processed (when an order goes from status `queued` to status `success`). This will not trigger on checkout.
`order/upcoming`	This will trigger X days before a QUEUED (prepaid) order is scheduled to be processed. The default is 3 days.
`order/updated`	This will trigger when an order is updated.

Plan webhooks

To use these webhooks your API Token must have read permissions for Plans enabled ( read_plans ).

Topic	Explanation
`plan/created`	This will trigger when a plan is created by one of the following methods: via API, via Merchant portal or when using the `2021-01` `Products` endpoint.
`plan/deleted`	This will trigger when a plan is deleted by one of the following methods: via API, via Merchant portal or when using the `2021-01` `Products` endpoint.
`plan/updated`	This will trigger when a plan is updated by one of the following methods: via API, via Merchant portal or when using the `2021-01` `Products` endpoint…

Subscription webhooks

To use these webhooks your API Token must have read permissions for Subscriptions enabled ( read_subscriptions ).

Topic	Explanation
`subscription/activated`	This will trigger when you activate a subscription via API or UI.
`subscription/cancelled`	This will trigger when you cancel a subscription via API or UI. An involuntary subscription cancelled due to max retries reached will only trigger the charge/max_retries_reached webhook and not the subscription/cancelled webhook.
`subscription/created`	This will trigger when you create a subscription via API or when you go through the checkout on UI.
`subscription/deleted`	This will trigger when you delete a subscription via API or UI.
`subscription/paused`	This will trigger when a customer pauses a subscription from within the customer portal.
`subscription/removed_from_skipped_charge`	This will trigger when the system removes a subscription from a customer’s skipped charge due to a rescheduled queued charge or subscription frequency change. The payload also includes relevant data from the affected charge object.
`subscription/skipped`	This will trigger when you skip a subscription within a charge, meaning that you only skip a particular subscription (the subscription_id you send in the body) in that charge if there are multiple subscriptions related to that charge.
`subscription/swapped`	This will trigger when you swap a subscription product for a given address to a different product or product variation API or UI.
`subscription/unskipped`	This will trigger when you unskip a subscription within a charge, meaning you only unskip a particular subscription (the subscription_id you send in the body) in that charge if there are multiple subscriptions related to that charge.
`subscription/updated`	This will trigger when you update a subscription via API (PUT method) or when you update the subscription via UI. This will also trigger when you update next charge date on Customer Portal, or when you change it using subscription endpoint `subscriptions/ <subscription_id>set_next_charge_date`.

Other webhooks

To use these webhooks your API Token must have read permissions for Store enabled ( read_store ).

Topic	Explanation
`recharge/uninstalled`	This will trigger when Recharge is uninstalled.
`store/updated`	This will trigger when and update has been made to the store.