Integrate With Subscriptions

Step-by-step guide on how to integrate Razorpay Subscriptions.


You can use Razorpay Subscriptions to set up and manage recurring payments. Integrate Razorpay Subscriptions by following these steps:

  • Create a Razorpay account.
  • Log in to the Razorpay Dashboard and . You need to use these keys while using our APIs and Checkout.

Follow these steps to create plans, subscriptions and accept payments from customers.

Step 1.1 Create a Plan

A Plan is a foundation on which a Subscription is built. It acts as a reusable template and contains details of the goods or services offered with the amount to be charged and the frequency at which the customer should be charged (billing cycle). Depending on your business, you can create multiple Plans with different billing cycles and pricing.

You should create a Plan before creating a Subscription via your checkout.

You can create Plans from the

or using .

Step 1.2 Create a Subscription

A Subscription contains details like the Plan, the start date, total number of billing cycles, free

(if any) and to be collected.

Subscriptions can be created from the

or using .

Step 1.3 Create an Add-On (Optional)

Add-ons can be charged to your customers at any time during the life of a Subscription. Add-ons are typically charged for extra services taken by a customer during the billing cycle.

Example
Consider, Acme Corp. is providing DTH services. A customer wants to add the sports channel pack, which costs an additional ₹500.00, to his Subscription only for the next month.

Before the next billing cycle, Acme Corp. can add ₹500.00 to the customer's current bill amount as an add-on.

Add-ons can be created from the

or using .

Step 1.4 Integrate With Standard Checkout

After you create a Subscription, you need the customer's permission to charge their card at periodic intervals. For this, the customer has to complete an authentication/authorisation transaction.

You can collect the authorisation transaction by passing the subscription_id along with the other options to the Razorpay Standard Checkout.

Once the authorisation transaction is successful, Razorpay returns the razorpay_payment_id, razorpay_subscription_id and the razorpay_signature.

Code to Add Pay Button

Use the sample code to initiate Razorpay Standard Checkout. Check the

.

<button id = "rzp-button1">Pay</button>
<script src = "https://checkout.razorpay.com/v1/checkout.js"></script>
<script>
var options = {
"key": "key_id",
"subscription_id": "sub_00000000000001",
"name": "Acme Corp.",
"description": "Monthly Test Plan",
"image": "/your_logo.jpg",
"callback_url": "https://eneqd3r9zrjok.x.pipedream.net/",
"prefill": {
"name": "Gaurav Kumar",
"email": "gaurav.kumar@example.com",
"contact": "+919876543210"
},
"notes": {
"note_key_1": "Tea. Earl Grey. Hot",
"note_key_2": "Make it so."
},
"theme": {
"color": "#F37254"
}
};
var rzp1 = new Razorpay(options);
document.getElementById('rzp-button1').onclick = function(e) {
rzp1.open();
e.preventDefault();
}
</script>

Failure Reasons and Next Steps

ErrorCauseSolution
Customer payment is not allowed for the Subscription at this stage.This error occurs when you are trying to make a payment for the next billing cycle during the current cycle.Users cannot pay for the next billing cycle during the current cycle.
Payment failed. Please contact the site admin.This error occurs when the amount of a plan exceeds the pricing plan configured to the business account for UPI.Ensure the minimum amount is greater than or equal to the configured pricing plan for the respective payment method, such as UPI recurring.
end_time must be between 946684800 and 4765046400 .This error occurs when the end date of the Subscription is beyond the acceptable limits or if the current start and end are null.Currently, you can only charge a Subscription for up to 10 years.
Oops! Something went wrong. Please contact the merchant for further assistance.
  • This error occurs when Flash Checkout is not enabled on the Razorpay Dashboard.
  • This error also occurs if the subscription_id is in the cancelled/expired state.
  • Ensure that flash checkout is enabled on the dashboard by navigating to Dashboard → Account & Settings → .
  • Ensure that the Subscription is in the authenticated or active state.

Payment Verification

This is a mandatory step that allows you to confirm the authenticity of the card details returned to the Checkout form for successful payments.

To verify the razorpay_signature returned to you by the Checkout form:

  1. Create a signature in your server using the following attributes:

    ParameterDescription
    subscription_idRetrieve the subscription_id from your server. Do not use the razorpay_subscription_id returned by Checkout.
    razorpay_payment_idReturned by Checkout.
    key_secretAvailable in your server.The key_secret that was generated from the Dashboard.
  2. Use the SHA256 algorithm, the razorpay_payment_id and the subscription_id to construct an HMAC hex digest as shown below:

    generated_signature = hmac_sha256(razorpay_payment_id + "|" + subscription_id, secret);
    if (generated_signature == razorpay_signature) {
    payment is successful
    }
  3. If the signature you generate on your server matches the razorpay_signature returned to you by the Checkout form, the payment received is from an authentic source.

You can test the integration by making a test payment using our cards:

TypeCard NetworkCard TypeCard NumberCVVExpiry Date
DomesticMastercardDebit Card5104 0600 0000 0008Random CVVAny future date.
DomesticVisaCredit Card4718 6091 0820 4366Random CVVAny future date.
InternationalMastercardCredit Card5104 0155 5555 5558Random CVVAny future date.

Consider the following steps before taking your integration live.

Switch Test API Keys With Live API Keys

After confirming if your integration is working successfully, you can take the integration live by switching the Test Mode API Keys with the Live Mode Keys.

Watch this video to know how to generate Live API keys:

Subscribe to Webhooks

to configure and receive notifications when a specific event occurs. When one of these events is triggered, we send an HTTP POST payload in JSON to the webhook's configured URL.

You can subscribe to these

.

Follow the best practices for a smooth Subscriptions integration.


  • Verify the received payments to confirm the authenticity of the mandate details returned to the Checkout form for successful payments.

  • Implement Razorpay Webhooks to receive notifications on various events of Subscriptions.

Is this integration guide useful?