POST
/
subscriptions
/
{subscription_id}
/
payments
/
{payment_id}
/
manage
Manage a single payment.
curl --request POST \
  --url https://sandbox.cashfree.com/pg/subscriptions/{subscription_id}/payments/{payment_id}/manage \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '{
  "payment_id": "Demo_Payment",
  "action": "RETRY",
  "action_details": {
    "next_scheduled_time": "2024-01-10T23:00:08+05:30"
  }
}'
{
  "authorization_details": {
    "authorization_amount": 1,
    "authorization_amount_refund": true,
    "start_time": "2024-04-18T16:40:00",
    "authorization_reference": "osduh20ijegaoinfbBjuweod31@upi",
    "authorization_time": "2024-04-18T16:45:00",
    "authorization_status": "ACTIVE",
    "payment_id": "test-payment-id"
  },
  "cf_payment_id": "123456",
  "cf_txn_id": "123456",
  "cf_order_id": "123456",
  "cf_subscription_id": "7891011",
  "failure_details": {
    "failure_reason": ""
  },
  "payment_amount": 1,
  "payment_id": "test-payment-id",
  "payment_initiated_date": "2024-04-18T22:14:58+0530",
  "payment_remarks": "authpayment",
  "payment_schedule_date": "",
  "payment_status": "SUCCESS",
  "payment_type": "AUTH",
  "retry_attempts": 0,
  "subscription_id": "test-subscription-id"
}

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

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.

​
payment_id
string
required

Provide the PaymentId using which the payment was created.

Body

application/json

Request body to manage a subscription payment.

Response

200
application/json

Fetched Manage Payment Response

The response returned in Get, Create or Manage Subscription Payment APIs.