Reports

You will learn the various reports involved in Cashfree Subscriptions.

The Subscription Payments report and the Subscriptions report help you view all the subscriptions and the associated transaction details in a single place. With the Subscriptions report you can view all the subscription details like subscription ID, status, customer name, the subscription creation date, and more in a single report. With the Subscription Payments report you can now easily link transactions to the respective subscription for further analysis. You can view these reports day-wise, week-wise or for a custom date range.

Subscriptions Report

With the Subscriptions report you can view details like subscription ID, status, customer name, the subscription creation date, and more in this report.

To view the subscriptions report,

  1. Go to Subscription Dashboard > Reports > click Generate New Report.
Generate Report

Generate Report

  1. In the Report Type field select Subscriptions. Next, select the Date Range for which you want to view the details.

  2. Specify a File Name and the File Format (CSV or XLSX) in which you want to view the report and click Generate Report.

Subscription Report Details

Subscription Report Details

The generated report is available in the Reports section, and you can download it for further analysis.

Report Generated

Report Generated

A sample subscription report is available here.

Column NameDescriptionExample
Subscription IDA unique ID for the subscription. It can include alphanumeric characters, underscore, dot, hyphen, and space. Maximum characters allowed is 200.test-ss-1697531619
Subscription Reference IDCashfree's internal subscription ID.6989236
Merchant IDID of the merchant. 603
Customer EmailEmail ID of the Customer (should be a valid email address, a maximum of 250 characters are allowed).[email protected]
Customer NameName of the customer. john doe
Customer PhonePhone number of the customer that was passed by the merchant. Should be a valid phone number, with or without +91.9999999999
Subscription Added OnDate/Time When the subscription was created.2023-10-17 17:55:42
Subscription Authorised OnDate/Time when the customer successfully creates the mandate.2023-10-17 17:56:43
Subscription Activated OnDate/Time when the subscription becomes active in Cashfree's System.2023-10-17 17:57:32
Subscription Expires OnDate on which the subscription expires. 2023-10-31 00:00:00
Sub StatusStatus of the subscription. Example - CUSTOMER_CANCELLED
LINK_EXPIRED, INITIALIZED.
LINK_EXPIRED
Auth AmountAmount that is debited when the mandate is authorised.1.00
Mandate Maximum AmountThe maximum amount that can be debited from the customer's account.15000.00
Recurring AmountThe recurring amount that is to be debited from the customer's account.2500.00
Plan IdID entered by merchant while creating the plan.plan-test
Plan NameName of the plan entered by merchant while creating the plan.abscede
Plan TypeType of plan. On Demand or Periodic. ON_DEMAND
Payment ModePayment mode used for creating the subscription.SBC_UPI
UMRNUMRN number received by NPCI. Applicable for Enach/Pnach, should be 20 characters.ICIC1111111111012563
UPI IDUPI ID of the subscription if the subscription was authorised by UPI as a payment method9999999999@ybl
UMNUnique mandate number. Applicable only for UPI.91869ed3af5f4e8e846ca6860fb1uyjf@okicici
MMS IDSI Hub mandate enrolment ID. Applicable only for Cards
Bank Account NumberBank Account Number with which mandate was authorised using eNACH. 50100777717817
Account Holder NameAccount Holder Name with which mandate was authorised using eNACH, should be maximum of 40 characters. john doe
Bank IDFirst 4 characters of IFSC code when the authorisation was done by eNACH.HDFC
Cycles CompletedNumber of cycles the subscription has completed.1
Max cyclesThe number of charge cycles that is needed before moving the subscription to COMPLETED state.4
IntervalInterval in which the customer will be charged.1
Interval typeTime period in which the customer will be charged. WEEK, or MONTH.WEEK
Is TPV enabledIf TPV is enabled or not. 0
Auth flowType of auth flow, example - UPI_COLLECT/UPI_INTENT/UPI_QR_MANDATE.UPI_COLLECT
Card numberCard number used for subscription. Applicable only for card payment mode.4706131211212123
NotesSubscription notes if any. subscription notes

Subscription Payments Report

With the Subscription Payments report, you can easily link transactions to the respective subscription for further analysis. You can generate this report for a date range of up to 1 year. You can view details like order ID, subscription ID, customer details, amount, subscription payment details, and more in this report.

To view the subscription payments report,

  1. Go to Subscription Dashboard > Reports > click Generate New Report.
Generate Report

Generate Report

  1. In the Report Type field select Subscription Payments. Next, select the Date Range for which you want to view the details, and specify a File Name and the File Format (CSV or XLSX) in which you want to view the report.

  2. Select the payment status and the subscription status you want to include in the report and click Generate Report.

Subscription Payments Report Details

Subscription Payments Report Details

The generated report is available in the Reports section, and you can download it for further analysis.

Report Generated

Subscription Payment Report Generated

A sample subscription payment report is available here.

Column NameDescriptionExample
Subscription Payment IDTransaction ID of the subscription.10719821
Order IDOrder ID that is available in PG reports. 9871538347
Reference IDTransaction Id in PG tables.

NOTE - in case the merchant wants the Settlement UTR number, they can use the value in this column and search the transactions details in the PG transaction reports
9122370902
Subscription IDA unique ID for the subscription passed by the merchant when creating the subscription. It can include alphanumeric characters, underscore, dot, hyphen, and space. Maximum characters allowed is 200.test-ss-1697545531619
Sub Reference IDCashfree's internal subscription ID. 6917320
Customer EmailEmail ID of the Customer that was entered when creating the subscription. Should be a valid email address, a maximum of 250 characters are allowed).[email protected]
Customer NameCustomer name provided when the subscription was created.john doe
Customer PhonePhone number of the customer (should be a valid phone number, with or without +91).9999999999
AmountTransaction amount.2500.00
Service ChargeService charged for the transaction.2.0
ST/GSTService tax. 0.36
SettlementSettlement status.SETTLED
Settlement AmountAmount that will be settled.-1.36
Payment ModePayment mode used for that subscription - UPI/ Cards/Enach.SBC_UPI
Bank IDBank ID of the customer. In case of ENach - Bank Id of the customer's account.HDFC
Bank Account NumberBank account number of the customer, should be a maximum of 35 characters. In case of ENach - Customer's Bank account number.50100777717817
Account Holder NameName of the account holder, should be maximum of 40 characters. johndoeICIC7010609220012563
UMRNUnique Mandate Reference Number. It is a unique identifier assigned to each mandate or authorization. In case of ENach - UMRN number of the ENachICIC1111111111012563
UPI IDUPI ID used for the subscription. In case of UPI - testsuccess@gocash9999999999@ybl
UMNUnique mandate number. Applicable only for UPI.f3c06a3572664d2caf1ad9877f7df98e@ybl
Subscription Payment Added OnThe date the transaction was created in Cashfree's system.2023-10-17 17:55:40
Subscription Payment Scheduled OnThe date the transaction was scheduled.2023-10-19
Subscription Payment Presentation DateActual date of debit of the transaction.2023-10-19
Subscription Payment Reconciliation TimeTime when the transaction came to terminal state.2023-10-19 21:35:01
Subscription Payment StatusStatus of the payment for the subscription. SUCCESS
Transaction MessageMessage associated with the transaction.auth payment
Merchant Txn IdMerchant provided Transaction ID. merchant-txn-id-888888
Failure ReasonReason why the transaction failed. Insufficient balance
Payment CycleCount of debits that have taken place for a given subscription.1
UTR No.Unique Transaction Reference Number. Applicable only for UPI Autopay.329060211111
RefundedThe type of refund, if Full/Partial refund. FULL