Notifications
Check the types of notifications available for Subscriptions, how they work and the steps to set up webhook events.
There are three types of notifications for Subscriptions: Email, SMS and Webhook notifications.
Your customers will receive an email and SMS at various events such as:
- The start of the Subscription.
- When a payment is successfully charged.
- When a payment fails.
- Action required by the customer in the event of a payment failure
- When the card linked to a Subscription is changed or updated.
- When a Subscription is moved to the
haltedstate post 3 retry attempts of payment failure. - When a Subscription is cancelled.
- When the details of a Subscription (such as plan, quantity or billing frequency) are updated.
Razorpay Curlec sends emails and SMS to customers at 8 different stages during the life cycle of a Subscription.
Created
An email and SMS is sent when you create and send a new Subscription link to a customer to make the authentication payment. The authenticated amount depends on the upfront_amount for the Subscriptions.
Initialized
An email and SMS is sent after the customer successfully makes the authentication payment.
Charged Successfully
An email and SMS is sent when we make a successful automated charge on the Subscription as per the billing cycle.
Completed
An email and SMS is sent to the customer when the Subscription moves to the completed state. There is no notification sent if the Subscription moves to the same state. This is because the Subscription is already in the completed state, and a charge was made on an older invoice.
Charged Failed
An email and SMS is sent when a charge on a card fails. When an automated charge on a Subscription fails, we retry an auto-charge on the card. If the retries are not exhausted, the Subscription moves to the pending state. We send out a notification (email and SMS) every time the Subscription moves to the pending state. The email and SMS contains an Update Card option for the customer to change the card details associated with the Subscription.
Card Updated
An email and SMS is sent whenever a customer changes the card details associated with the Subscription. This notification notifies the customer that their new card details are now successfully updated.
Invoice Charge
An email and SMS is sent when a manual charge is made on an old Subscription invoice (either by you or the customer). If the Subscription was in the halted state, we also mention that the Subscription is now active, and we will resume the automated charges from the next cycle onwards in the notification.
Halted
When an automated charge on a Subscription fails, we retry an auto-charge on the card. When all the retries are exhausted, it moves to the halted state. We send out a notification (email and SMS) every time the Subscription moves to the halted state. These notifications contain the Update Card option to change the card linked to the Subscription.
Cancelled
An email and SMS is sent when the Subscription moves to the cancelled state. This happens because either you or your customer cancelled the Subscription.
Subscription Updated
An email and SMS is sent when the Subscription is successfully updated. There is no state change when a Subscription is updated.
To set up webhooks:
-
Log in to the Dashboard and navigate to Accounts & Settings.
-
Click Webhooks under Website and app settings.
-
Click the + Add New Webhook button.
-
In the Webhook Setup pop-up page:
-
Enter the URL where you want to receive the webhook payload when an event is triggered. We recommend using an HTTPS URL.
Handy Tips
- You can set up to 30 URLs to receive Webhook notifications. Webhooks can only be delivered to public URLs.
- If your URL contains
razorpayas a domain, you will not be able to add the URL and will receive an error. - If you attempt to save a localhost endpoint as part of a webhook setup, you will notice an error. Know more about .
-
Enter a Secret for the webhook endpoint. The secret is used to validate that the webhook is from Razorpay. Do not expose the secret publicly. Know more about
.Handy Tips
- When setting up the webhook, specify a secret. Use this secret to validate that the webhook is from Razorpay. Entering the secret is optional but recommended. The secret should never be exposed publicly.
- The webhook secret does not need to be the Razorpay API key secret.
-
In the Alert Email field, enter the email address to which the notifications should be sent in case of webhook failure. You will receive webhook related notifications like failures, deactivation and so on.
-
Select the required events from the list of Active Events.
-
-
Click Create Webhook. After you set up a webhook, it appears on the list of webhooks.
-
You can select the webhook and click Edit to make more changes.
The table below lists the Webhook events available for Subscriptions.
Handy Tips
The payload for all these events contain the subscription entity. They also contain a payment entity if a payment attempt was made before the event was triggered.
For sample payloads, refer to the
in the API document.Was this page helpful?