Fetch details of all payments of a subscription.

Use this API to fetch all payments of a subscription.

Authorizations

x-client-id · string · header · required

Client app ID. You can find your app id in the merchant dashboard.

x-client-secret · string · header · required

Client secret key. You can find your secret key in the merchant dashboard.

Headers

x-api-version · string · default: 2025-01-01 · required

API version to be used. Format is in YYYY-MM-DD.

x-request-id · string

Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to Cashfree.

x-idempotency-key · string<UUID>

An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.

Path Parameters

subscription_id · string · required

Provide the SubscriptionId using which the subscription was created.

Response

200

application/json

Fetched all payments of subscription

authorization_details · object

Details of the authorization done for the subscription. Returned in Get subscription and payments.

Show child attributes

Example:

{
  "authorization_amount": 1,
  "authorization_amount_refund": false,
  "authorization_reference": "",
  "authorization_time": "2025-06-01T23:47:52+05:30",
  "authorization_status": "INITIALIZED",
  "payment_id": "97877",
  "payment_group": "upi",
  "payment_method": {
    "upi": {
      "channel": "collect",
      "upi_id": "test@upi",
      "upi_instrument": "upiInstrument",
      "upi_instrument_number": "1234567890",
      "upi_payer_account_number": "039861903074",
      "upi_payer_ifsc": "SBIN0001234"
    }
  }
}

cf_payment_id · string

Cashfree subscription payment reference number

cf_subscription_id · string

Cashfree subscription reference number

cf_txn_id · string

Cashfree subscription payment transaction ID

cf_order_id · string

Cashfree subscription payment order ID

failure_details · object

Show child attributes

payment_amount · number

The charge amount of the payment.

payment_id · string

A unique ID passed by merchant for identifying the transaction.

payment_initiated_date · string<ISO8601>

The date on which the payment was initiated. Cashfree stores timestamps in IST.

Example:

"2025-06-01T10:20:12+05:30"

payment_remarks · string

Payment remarks.

payment_schedule_date · string

The date on which the payment is scheduled to be processed. Cashfree stores timestamps in IST, but you can provide them in a valid ISO 8601 time format.

For IST this 2025-06-01T10:20:12+05:30 translates to 2025-06-01 10:20:12

For UTC this 2025-06-01T10:20:12Z translates to 2025-06-01 15:50:12+05:30.

payment_status · string

Status of the payment.

payment_type · string

Payment type. Can be AUTH or CHARGE.

retry_attempts · integer

Retry attempts.

subscription_id · string

A unique ID passed by merchant for identifying the subscription.