Cancel a Recurring Gift
curl --request PUT \
--url https://api.virtuoussoftware.com/api/RecurringGift/Cancel/{recurringGiftId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cancelReason": "<string>",
"categoryId": "<integer>"
}
'const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({cancelReason: '<string>', categoryId: '<integer>'})
};
fetch('https://api.virtuoussoftware.com/api/RecurringGift/Cancel/{recurringGiftId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/RecurringGift/Cancel/{recurringGiftId}"
payload = {
"cancelReason": "<string>",
"categoryId": "<integer>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.virtuoussoftware.com/api/RecurringGift/Cancel/{recurringGiftId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"cancelReason\": \"<string>\",\n \"categoryId\": \"<integer>\"\n}", false);
var response = await client.PutAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.virtuoussoftware.com/api/RecurringGift/Cancel/{recurringGiftId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'cancelReason' => '<string>',
'categoryId' => '<integer>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.put("https://api.virtuoussoftware.com/api/RecurringGift/Cancel/{recurringGiftId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"cancelReason\": \"<string>\",\n \"categoryId\": \"<integer>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.virtuoussoftware.com/api/RecurringGift/Cancel/{recurringGiftId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cancelReason\": \"<string>\",\n \"categoryId\": \"<integer>\"\n}"
response = http.request(request)
puts response.read_bodyconst url = 'https://api.virtuoussoftware.com/api/RecurringGift/Cancel/{recurringGiftId}';
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({cancelReason: '<string>', categoryId: '<integer>'})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"id": 700089,
"transactionSource": null,
"transactionId": null,
"contactId": 100456,
"startDate": "2023-02-15T00:00:00Z",
"amount": 50,
"frequency": "Monthly",
"anticipatedEndDate": null,
"cancelDateTimeUtc": "2025-11-15T18:00:00Z",
"createDateTimeUtc": "2023-02-15T10:30:00Z",
"createdByUser": "Online Form",
"modifiedDateTimeUtc": "2025-11-15T18:00:00Z",
"modifiedByUser": "Partner Integration",
"segmentId": null,
"segment": null,
"segmentUrl": null,
"automatedPayments": true,
"trackPayments": true,
"isPrivate": false,
"status": "Cancelled",
"nextExpectedPaymentDate": null,
"designations": [
{
"projectId": 1001,
"project": "General Fund",
"projectUrl": "https://api.virtuoussoftware.com/api/Project/1001",
"amountDesignated": 50,
"projectCode": "GEN"
}
],
"customFields": []
}{
"message": "Authorization has been denied for this request."
}{
"message": "You do not have permission to perform this action."
}{
"message": "Rate limit exceeded. Try again later."
}Giving
Cancel a Recurring Gift
Cancels the recurring gift so no further payments are expected. Send a cancelReason, and a categoryId to group the cancellation for reporting. Payments already recorded are kept.
PUT
/
api
/
RecurringGift
/
Cancel
/
{recurringGiftId}
Cancel a Recurring Gift
curl --request PUT \
--url https://api.virtuoussoftware.com/api/RecurringGift/Cancel/{recurringGiftId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cancelReason": "<string>",
"categoryId": "<integer>"
}
'const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({cancelReason: '<string>', categoryId: '<integer>'})
};
fetch('https://api.virtuoussoftware.com/api/RecurringGift/Cancel/{recurringGiftId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/RecurringGift/Cancel/{recurringGiftId}"
payload = {
"cancelReason": "<string>",
"categoryId": "<integer>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.virtuoussoftware.com/api/RecurringGift/Cancel/{recurringGiftId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"cancelReason\": \"<string>\",\n \"categoryId\": \"<integer>\"\n}", false);
var response = await client.PutAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.virtuoussoftware.com/api/RecurringGift/Cancel/{recurringGiftId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'cancelReason' => '<string>',
'categoryId' => '<integer>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.put("https://api.virtuoussoftware.com/api/RecurringGift/Cancel/{recurringGiftId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"cancelReason\": \"<string>\",\n \"categoryId\": \"<integer>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.virtuoussoftware.com/api/RecurringGift/Cancel/{recurringGiftId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cancelReason\": \"<string>\",\n \"categoryId\": \"<integer>\"\n}"
response = http.request(request)
puts response.read_bodyconst url = 'https://api.virtuoussoftware.com/api/RecurringGift/Cancel/{recurringGiftId}';
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({cancelReason: '<string>', categoryId: '<integer>'})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"id": 700089,
"transactionSource": null,
"transactionId": null,
"contactId": 100456,
"startDate": "2023-02-15T00:00:00Z",
"amount": 50,
"frequency": "Monthly",
"anticipatedEndDate": null,
"cancelDateTimeUtc": "2025-11-15T18:00:00Z",
"createDateTimeUtc": "2023-02-15T10:30:00Z",
"createdByUser": "Online Form",
"modifiedDateTimeUtc": "2025-11-15T18:00:00Z",
"modifiedByUser": "Partner Integration",
"segmentId": null,
"segment": null,
"segmentUrl": null,
"automatedPayments": true,
"trackPayments": true,
"isPrivate": false,
"status": "Cancelled",
"nextExpectedPaymentDate": null,
"designations": [
{
"projectId": 1001,
"project": "General Fund",
"projectUrl": "https://api.virtuoussoftware.com/api/Project/1001",
"amountDesignated": 50,
"projectCode": "GEN"
}
],
"customFields": []
}{
"message": "Authorization has been denied for this request."
}{
"message": "You do not have permission to perform this action."
}{
"message": "Rate limit exceeded. Try again later."
}Authorizations
Body
application/json
Response
OK
Was this page helpful?