post https://api.cashfree.com/api/v2/subscriptions//charge-retry
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.
URLs
Maximum retries allowed are 3 per cycle & 1 for a day. Retry is not allowed if the cycle has expired.
nextScheduledOn Functionality
Let us see how the nextScheduledOn functionality works for different payment modes with an example.
| Cycle Debit Dates | Cycle Start & End Date |
|---|---|
| 5th January | 5th January to 4th February |
| 5th February | 5th February to 4th March |
| 5th March | 5th March to 4th April |
Case 1: Payment Mode: eNACH (Debit fails on 5th March)
| Retry Attempted Date | nextScheduledOn Date | Debit Date | Terminal State of Debit | Next Debit Date (set only after the current retry is successful) |
|---|---|---|---|---|
| 7th March (11 am) | not provided | 8th March | Debit successful on: 8th March EOD | Since the debit is successful, the next debit dates are - - 8th March - 8th April - 8th May and so on… |
| 7th March (11 am) | not provided | 8th March | Debit fails on: 8th March EOD | Since the debit fails, the subscription will remain to be in ON HOLD status. Also, no future debits will be scheduled. |
| 7th March (before 7 am) | not provided | 7th March | Debit successful on: 7th March EOD | Since the debit was successful on 7th March, the next debit dates are - - 7th April - 7th May - 7th June and so on… |
| 7th March (11 am) | 5th April | 8th March | Debit successful on: 8th March EOD | Since the retry & debit is successful, the next debit dates as per the nextScheduledOn - - 5th April - 5th May - 5th June and so on… |
| 7th March (11 am) | 10th May | 8th March | Debit successful on: 8th March EOD | Since the retry & debit is successful, the next debit dates as per the nextScheduledOn - - 10th May - 10th June - 10th July and so on… |
| 7th March (11 am) | 25th March | Error - Only one debit can be performed in a cycle. | Error - Only one debit can be performed in a cycle. | Error - Only one debit can be performed in a cycle. |
| 8th April (11 am) | not provided | Error - Retry fails as you cannot retry a transaction out of the cycle date. | Error - Retry fails as you cannot retry a transaction out of the cycle date. | Error - Retry fails as you cannot retry a transaction out of the cycle date. |
Case 2: Payment Mode: UPI AutoPay (Debit fails on 5th March)
| Retry Attempted Date | nextScheduledOn Date | Debit Date | Terminal State of Debit | Next Debit Date (set only after the current retry is successful) |
|---|---|---|---|---|
| 7th March (before 6 pm) | not provided | 8th March | Debit successful on: - 8th March EOD | Since the debit is successful, the next debit dates are: - 8th March - 8th April - 8th May and so on… |
| 7th March (after 6 pm) | not provided | 9th March | Debit successful on: 9th March EOD | Since the debit is successful, the next debit dates are: - 9th March - 9th April - 9th May and so on… |
| 7th March (before 6 pm) | 5th April | 8th March | Debit successful on: 8th March EOD | Since the debit is successful, the next debit dates as per the nextScheduledOn - - 5th April - 5th May - 5th June and so on… |
| 7th March (before 6 pm) | 10th May | 8th March | Debit successful on: 8th March EOD | Since the debit is successful, the next debit dates as per the nextScheduledOn - - 10th May - 10th June - 10th July and so on… |
| 7th March (before 6 pm) | 25th March | Error - Retry fails as only one debit can be performed in a cycle. | Error - Retry fails as only one debit can be performed in a cycle. | Error - Retry fails as only one debit can be performed in a cycle. |
| 8th April (11 am) | not provided | Error - Retry fails as you cannot retry a transaction out of the cycle date. | Error - Retry fails as you cannot retry a transaction out of the cycle date. | Error - Retry fails as you cannot retry a transaction out of the cycle date. |