Retry Subscription Charge

Applicable only for Periodic Subscriptions. Use this API to retry the last failed payment for a subscription in ON HOLD state. On a successful retry, the subscription gets activated. Use the Retry API when the subscription debit has failed at your customer’s end. Only one retry attempt is allowed per day and 3 retry attempts are allowed for a failed transaction within the cycle. Retry is not allowed if the current cycle expires.

POST /api/v2/subscriptions/{subReferenceId}/charge-retry

Retry Subscription Charge

cURL

curl --request POST \
  --url https://sandbox.cashfree.com/api/v2/subscriptions/{subReferenceId}/charge-retry \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <x-client-id>' \
  --header 'X-Client-Secret: <x-client-secret>' \
  --data '
{
  "nextScheduledOn": "2021-12-17"
}
'

200

Retry Subscription Charge Success

{ "status": "OK", "subStatus": "ON_HOLD", "payment": { "paymentId": 3293789, "amount": 1, "status": "PENDING", "addedOn": "2021-12-17 08:41:30", "retryAttempts": 2 } }

Headers

X-Client-Id · string · required

Client ID provided by Cashfree.

Example:

"asdf1234"

X-Client-Secret · string · required

Client Secret provided by Cashfree.

Example:

"qwer9876"

Path Parameters

subReferenceId · integer · required

The reference ID of the subscription to retry the charge.

Example:

2646214

Body

application/json

nextScheduledOn · string<date>

Date for the next scheduled retry.

Example:

"2021-12-17"

Response

200

application/json

Successful retry of the subscription charge.