Cancel Subscription

Use this API to cancel the subscription. After a successful cancellation, the subscription status will move to “CANCELLED”, and the customer will no longer be charged. Subscription, once cancelled, cannot be reactivated.

POST /api/v2/subscriptions/{subReferenceId}/cancel

Cancel Subscription

cURL

curl --request POST \
  --url https://sandbox.cashfree.com/api/v2/subscriptions/{subReferenceId}/cancel \
  --header 'X-Client-Id: <x-client-id>' \
  --header 'X-Client-Secret: <x-client-secret>'

200

{
  "status": "OK",
  "message": "Subscription Cancelled"
}

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 be cancelled.

Example:

2749411

Response

200

application/json

Successful cancellation of the subscription.