Skip to main content
The Subscription APIs provide RESTful endpoints for managing recurring payments, customer mandates, and automated billing schedules. These APIs support both sandbox testing and production environments with consistent authentication and error handling across all endpoints. Real-time webhooks ensure seamless integration for subscription lifecycle events, payment notifications, and mandate status updates.

ā€‹
API endpoints

EnvironmentBase URL
Testhttps://sandbox.cashfree.com/pg
Productionhttps://api.cashfree.com/pg
Latest versionv5, 2025-01-01

ā€‹
Authentication

All Subscription APIs require authentication. Refer to the Authentication guide for detailed information on API authentication for merchants and partners.

ā€‹
Subscription APIs

ā€‹
Plan management

Create Plan

Define subscription terms including billing frequency, amount, and recurring payment parameters.

Fetch Plan

Retrieve details of an existing subscription plan using plan ID.

ā€‹
Mandate (Subscription) management

Create Subscription

Create a subscription mandate with customer details and payment method authorization.

Fetch Subscription

Retrieve subscription details using subscription ID or subscription reference ID.

Manage Subscription

Update subscription status to activate, pause, or cancel a customer mandate.

Upload Physical NACH Form

Upload physical NACH registration forms for signature-based mandate creation.

Get Payment Methods

Fetch available payment methods and configurations for subscription creation.

Generate Transaction Summary

Generate downloadable transaction summary reports for a subscription.

ā€‹
Supported payment methods

Cashfree Subscriptions supports the following payment methods for recurring payments:
  • Bank account (e-Mandate): Net banking, debit card, or Aadhaar-based authorization with up to ā‚¹1,00,00,000 mandate amount
  • Bank account (Physical mandate): Signature-based NACH mandate for accounts without digital access
  • UPI Autopay: Recurring payments via UPI applications with ā‚¹15,000-ā‚¹1,00,000 limits based on authentication
  • Standing Instructions (SI) on cards: Credit or debit cards (Indian and International) with flexible amount limits
For detailed payment method information, refer to the Supported Payment Methods guide.

ā€‹
Getting started

Complete the following steps to set up subscriptions using Cashfree APIs:
  1. Create a Plan (optional): Define your subscription terms including billing frequency and amount
  2. Create a Subscription: Set up a mandate with customer details and payment method
  3. Customer Authorization: Customer authorizes the recurring payment through their chosen method
  4. Raise Payments: Initiate recurring charges as per the subscription schedule
  5. Manage Subscriptions: Update subscription status, handle payment retries, and process refunds
For a comprehensive integration guide, visit the Subscription Introduction page.