GET
/
subscriptions
/
{subscription_id}
/
payments

Authorizations

x-client-id
string
headerrequired

Client app ID. You can find your app id in the Merchant Dashboard.

x-client-secret
string
headerrequired

Client secret key. You can find your secret in the Merchant Dashboard.

Headers

x-api-version
string
default: 2023-08-01required

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

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
authorization_details
object

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

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
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

The date on which the payment was initiated.

payment_remarks
string

Payment remarks.

payment_schedule_date
string

The date on which the payment is scheduled to be processed.

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.