POST
/
subscriptions
/
{subscription_id}
/
refunds
Create a refund.
curl --request POST \
  --url https://sandbox.cashfree.com/pg/subscriptions/{subscription_id}/refunds \
  --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 '{
  "subscription_id": "test-subs-id",
  "payment_id": "test-payment-id",
  "refund_id": "dummy-test-refund-id",
  "refund_amount": 10,
  "refund_note": "full refund",
  "refund_speed": "INSTANT",
  "cf_payment_id": 1234235
}'
{
  "payment_id": "pay8643",
  "cf_payment_id": "863782648",
  "refund_id": "refund2",
  "cf_refund_id": "ref_212",
  "refund_amount": 100,
  "refund_note": "test",
  "refund_speed": "INSTANT",
  "refund_status": "INITIATED"
}

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.

Body

application/json

Request body to create a subscription refund.

Response

200
application/json

Refund Initiated

Get/Create Subscription Payment Refund Response