PUT
/
api
/
v2
/
subscriptions
/
{subReferenceId}
/
pause-subscription
Pause Subscription
curl --request PUT \
  --url https://sandbox.cashfree.com/api/v2/subscriptions/{subReferenceId}/pause-subscription \
  --header 'X-Client-Id: <x-client-id>' \
  --header 'X-Client-Secret: <x-client-secret>'
{
"status": "OK",
"message": "Subscription paused successfully"
}

Headers

X-Client-Id
string
required

Client ID provided by Cashfree.

Example:

"clientId123"

X-Client-Secret
string
required

Client Secret provided by Cashfree.

Example:

"clientSecret456"

Path Parameters

subReferenceId
integer
required

The reference ID of the subscription to be paused.

Example:

95491

Response

200
application/json

Successful pause of the subscription.

The response is of type any.