Cashfree Subscription enables you to manage recurring payments. You can easily create and manage subscriptions and charge your customers automatically as per the plans defined by you. Whatever be your business model, you can use Cashfree as your building block. The Subscription service is available through the Dashboard and API. To get started with Subscription you need to follow the below steps -

  • Create plans
  • Create subscriptions and Authorize
  • Manage subscriptions

Get started easily with Cashfree Subscriptions by downloading the following collection and importing it in Postman from here

Step 1: Create Plan

To get started with a subscription, you need to create a plan. This plan is basically a template where you define the details and the amount which you will be charging your customers.

To create a new plan go to the Cashfree dashboard ->Subscriptions -> Plans -> New Plan. You need to provide the below details to create a new plan:

  • Plan ID - used to uniquely identify each plan (mandatory field)
  • Plan Name - specify a name to the plan for easy reference (mandatory field)
  • Description - a brief used for later reference (optional field)
  • Plan Type - can be a periodic plan or an on-demand plan
  • Interval Type - interval as per choice say monthly, weekly, etc
  • Amount - the cost of the plan (mandatory field)

subscription

Step 2:Create Subscription

After you have successfully created the plan, the next step is to create a subscription to charge the customers as per the plan created in the previous step

To create a new Subscription go to Cashfree Merchant dashboard -> Subscriptions -> View Subscriptions -> click on New Subscription.

The Subscription section captures information related to the plan:

  • Subscription Id - used to uniquely identify each subscription (mandatory field)
  • Plan - name of the plan created earlier
  • Customer Email & Customer Phone- contact details of the customer
  • Expiry date - the last day till the subscription is valid
  • Note - brief for future reference (optional)
  • ReturnURL - valid url to which customer will be redirected after the subscription has been authorized (optional)

Click on Create, the subscription is created!

subscription

Once you have created the subscription, a Reference Id and an Authorization link (refer screenshot) will be generated. You need to share this link with the customer, who can easily authorize the subscription either by providing the card details under the card section or the account number under the E-mandate section.

subscription

subscription

Step 3: Manage Subscription

Once the customer has authorized the subscription, you can easily debit their account either periodically or as per an on-demand plan. In case of a periodic plan, Cashfree will auto-debit the customer's account as per the plan interval. For an On-Demand plan, you will have to explicitly debit the customer's account.

The customer will receive a notification from their respective bank regarding the payment.

If by any chance the subscription fails either due to deauthorization of payment, expiration of payment method or insufficient funds at payment method, the status of the subscription changes to ON-HOLD. You will have to contact the customer regarding the issue and later after your consent, Cashfree will change the status to ACTIVE.

If at any instance you wish to cancel a subscription, you can go to the Cashfree merchant dashboard -> Subscriptions -> View Subscriptions -> Subscription Details -> click on Cancel. The customer will no longer be charged (Refer screenshot)

subscription

© 2019 Cashfree Payments India Pvt Ltd