POST
/
api
/
v2
/
subscriptions
/
{subReferenceId}
/
charge
{
  "status": "OK",
  "message": "Subscription charge initialized",
  "payment": {
    "paymentId": 122129,
    "cfOrderId": 112234,
    "referenceId": null,
    "subReferenceId": 110386,
    "currency": "INR",
    "amount": 1,
    "cycle": 1,
    "status": "INITIALIZED",
    "addedOn": "2023-01-19 16:49:49",
    "retryAttempts": 0,
    "remarks": "",
    "failureReason": "",
    "scheduledOn": "2023-01-20",
    "initiatedOn": "2023-01-19",
    "merchantTxnId": "test-txn-id-888"
  }
}

Headers

X-Client-Id
string
required

Client ID provided by Cashfree.

X-Client-Secret
string
required

Client Secret provided by Cashfree.

Path Parameters

subReferenceId
integer
required

The reference ID of the subscription to be charged.

Body

application/json
amount
number

Amount to be charged.

merchantTxnId
string

Merchant transaction ID for the charge.

remarks
string

Remarks for the charge.

scheduledOn
string

Date to schedule the charge.

Response

200 - application/json

The response is of type any.