Cancel Subscription Charge
curl --request POST \
--url https://sandbox.cashfree.com/api/v2/subscription/{subReferenceId}/charge/{chargeId}/cancel \
--header 'X-Client-Id: <x-client-id>' \
--header 'X-Client-Secret: <x-client-secret>'import requests
url = "https://sandbox.cashfree.com/api/v2/subscription/{subReferenceId}/charge/{chargeId}/cancel"
headers = {
"X-Client-Id": "<x-client-id>",
"X-Client-Secret": "<x-client-secret>"
}
response = requests.post(url, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Client-Id': '<x-client-id>', 'X-Client-Secret': '<x-client-secret>'}
};
fetch('https://sandbox.cashfree.com/api/v2/subscription/{subReferenceId}/charge/{chargeId}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.cashfree.com/api/v2/subscription/{subReferenceId}/charge/{chargeId}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"X-Client-Id: <x-client-id>",
"X-Client-Secret: <x-client-secret>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.cashfree.com/api/v2/subscription/{subReferenceId}/charge/{chargeId}/cancel"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-Client-Id", "<x-client-id>")
req.Header.Add("X-Client-Secret", "<x-client-secret>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.cashfree.com/api/v2/subscription/{subReferenceId}/charge/{chargeId}/cancel")
.header("X-Client-Id", "<x-client-id>")
.header("X-Client-Secret", "<x-client-secret>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.cashfree.com/api/v2/subscription/{subReferenceId}/charge/{chargeId}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Client-Id"] = '<x-client-id>'
request["X-Client-Secret"] = '<x-client-secret>'
response = http.request(request)
puts response.read_body{
"status": "OK",
"message": "Subscription charge cancelled",
"payment": {
"paymentId": 2276563,
"referenceId": 214308920,
"subReferenceId": 5513463,
"cfOrderId": 236286405,
"currency": "INR",
"amount": 250,
"cycle": 5,
"status": "CANCELLED",
"remarks": null,
"scheduledOn": "2021-09-13",
"addedOn": "2021-09-09 11:05:19",
"retryAttempts": 0,
"failureReason": null
}
}{
"status": "ERROR",
"subCode": "400",
"message": "Invalid subscription or charge ID provided."
}{
"status": "ERROR",
"message": "Server encountered an unexpected condition."
}Subscription
Cancel Subscription Charge
Use this API to cancel a transaction that is in the INITIALIZED state.
POST
/
api
/
v2
/
subscription
/
{subReferenceId}
/
charge
/
{chargeId}
/
cancel
Cancel Subscription Charge
curl --request POST \
--url https://sandbox.cashfree.com/api/v2/subscription/{subReferenceId}/charge/{chargeId}/cancel \
--header 'X-Client-Id: <x-client-id>' \
--header 'X-Client-Secret: <x-client-secret>'import requests
url = "https://sandbox.cashfree.com/api/v2/subscription/{subReferenceId}/charge/{chargeId}/cancel"
headers = {
"X-Client-Id": "<x-client-id>",
"X-Client-Secret": "<x-client-secret>"
}
response = requests.post(url, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Client-Id': '<x-client-id>', 'X-Client-Secret': '<x-client-secret>'}
};
fetch('https://sandbox.cashfree.com/api/v2/subscription/{subReferenceId}/charge/{chargeId}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.cashfree.com/api/v2/subscription/{subReferenceId}/charge/{chargeId}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"X-Client-Id: <x-client-id>",
"X-Client-Secret: <x-client-secret>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.cashfree.com/api/v2/subscription/{subReferenceId}/charge/{chargeId}/cancel"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-Client-Id", "<x-client-id>")
req.Header.Add("X-Client-Secret", "<x-client-secret>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.cashfree.com/api/v2/subscription/{subReferenceId}/charge/{chargeId}/cancel")
.header("X-Client-Id", "<x-client-id>")
.header("X-Client-Secret", "<x-client-secret>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.cashfree.com/api/v2/subscription/{subReferenceId}/charge/{chargeId}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Client-Id"] = '<x-client-id>'
request["X-Client-Secret"] = '<x-client-secret>'
response = http.request(request)
puts response.read_body{
"status": "OK",
"message": "Subscription charge cancelled",
"payment": {
"paymentId": 2276563,
"referenceId": 214308920,
"subReferenceId": 5513463,
"cfOrderId": 236286405,
"currency": "INR",
"amount": 250,
"cycle": 5,
"status": "CANCELLED",
"remarks": null,
"scheduledOn": "2021-09-13",
"addedOn": "2021-09-09 11:05:19",
"retryAttempts": 0,
"failureReason": null
}
}{
"status": "ERROR",
"subCode": "400",
"message": "Invalid subscription or charge ID provided."
}{
"status": "ERROR",
"message": "Server encountered an unexpected condition."
}Headers
Client ID provided by Cashfree.
Example:
"asdf1234"
Client Secret provided by Cashfree.
Example:
"qwer9876"
Path Parameters
The reference ID of the subscription.
Example:
123456
The ID of the charge to be cancelled.
Example:
9876543
Response
Successful cancellation of the subscription charge.
Was this page helpful?
āI