Create a Recurring Gift
curl --request POST \
--url https://api.virtuoussoftware.com/api/RecurringGift \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contactId": "<integer>",
"startDate": "<dateTime>",
"frequency": "Weekly|Bimonthly|Monthly|Quarterly|Semiannually|Annually|Biennially",
"amount": "<double>",
"nextExpectedPaymentDate": "<dateTime>",
"anticipatedEndDate": "<dateTime>",
"thankYouDate": "<dateTime>",
"segmentId": "<integer>",
"automatedPayments": "<boolean>",
"trackPayments": "<boolean>",
"isPrivate": "<boolean>",
"designations": [
{
"projectId": "<integer>",
"amountDesignated": "<double>"
},
{
"projectId": "<integer>",
"amountDesignated": "<double>"
}
],
"customFields": [
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
},
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contactId: '<integer>',
startDate: '<dateTime>',
frequency: 'Weekly|Bimonthly|Monthly|Quarterly|Semiannually|Annually|Biennially',
amount: '<double>',
nextExpectedPaymentDate: '<dateTime>',
anticipatedEndDate: '<dateTime>',
thankYouDate: '<dateTime>',
segmentId: '<integer>',
automatedPayments: '<boolean>',
trackPayments: '<boolean>',
isPrivate: '<boolean>',
designations: [
{projectId: '<integer>', amountDesignated: '<double>'},
{projectId: '<integer>', amountDesignated: '<double>'}
],
customFields: [
{name: '<string>', value: '<string>', displayName: '<string>'},
{name: '<string>', value: '<string>', displayName: '<string>'}
]
})
};
fetch('https://api.virtuoussoftware.com/api/RecurringGift', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/RecurringGift"
payload = {
"contactId": "<integer>",
"startDate": "<dateTime>",
"frequency": "Weekly|Bimonthly|Monthly|Quarterly|Semiannually|Annually|Biennially",
"amount": "<double>",
"nextExpectedPaymentDate": "<dateTime>",
"anticipatedEndDate": "<dateTime>",
"thankYouDate": "<dateTime>",
"segmentId": "<integer>",
"automatedPayments": "<boolean>",
"trackPayments": "<boolean>",
"isPrivate": "<boolean>",
"designations": [
{
"projectId": "<integer>",
"amountDesignated": "<double>"
},
{
"projectId": "<integer>",
"amountDesignated": "<double>"
}
],
"customFields": [
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
},
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.virtuoussoftware.com/api/RecurringGift");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"contactId\": \"<integer>\",\n \"startDate\": \"<dateTime>\",\n \"frequency\": \"Weekly|Bimonthly|Monthly|Quarterly|Semiannually|Annually|Biennially\",\n \"amount\": \"<double>\",\n \"nextExpectedPaymentDate\": \"<dateTime>\",\n \"anticipatedEndDate\": \"<dateTime>\",\n \"thankYouDate\": \"<dateTime>\",\n \"segmentId\": \"<integer>\",\n \"automatedPayments\": \"<boolean>\",\n \"trackPayments\": \"<boolean>\",\n \"isPrivate\": \"<boolean>\",\n \"designations\": [\n {\n \"projectId\": \"<integer>\",\n \"amountDesignated\": \"<double>\"\n },\n {\n \"projectId\": \"<integer>\",\n \"amountDesignated\": \"<double>\"\n }\n ],\n \"customFields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n }\n ]\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.virtuoussoftware.com/api/RecurringGift",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'contactId' => '<integer>',
'startDate' => '<dateTime>',
'frequency' => 'Weekly|Bimonthly|Monthly|Quarterly|Semiannually|Annually|Biennially',
'amount' => '<double>',
'nextExpectedPaymentDate' => '<dateTime>',
'anticipatedEndDate' => '<dateTime>',
'thankYouDate' => '<dateTime>',
'segmentId' => '<integer>',
'automatedPayments' => '<boolean>',
'trackPayments' => '<boolean>',
'isPrivate' => '<boolean>',
'designations' => [
[
'projectId' => '<integer>',
'amountDesignated' => '<double>'
],
[
'projectId' => '<integer>',
'amountDesignated' => '<double>'
]
],
'customFields' => [
[
'name' => '<string>',
'value' => '<string>',
'displayName' => '<string>'
],
[
'name' => '<string>',
'value' => '<string>',
'displayName' => '<string>'
]
]
]),
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.post("https://api.virtuoussoftware.com/api/RecurringGift")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contactId\": \"<integer>\",\n \"startDate\": \"<dateTime>\",\n \"frequency\": \"Weekly|Bimonthly|Monthly|Quarterly|Semiannually|Annually|Biennially\",\n \"amount\": \"<double>\",\n \"nextExpectedPaymentDate\": \"<dateTime>\",\n \"anticipatedEndDate\": \"<dateTime>\",\n \"thankYouDate\": \"<dateTime>\",\n \"segmentId\": \"<integer>\",\n \"automatedPayments\": \"<boolean>\",\n \"trackPayments\": \"<boolean>\",\n \"isPrivate\": \"<boolean>\",\n \"designations\": [\n {\n \"projectId\": \"<integer>\",\n \"amountDesignated\": \"<double>\"\n },\n {\n \"projectId\": \"<integer>\",\n \"amountDesignated\": \"<double>\"\n }\n ],\n \"customFields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.virtuoussoftware.com/api/RecurringGift")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contactId\": \"<integer>\",\n \"startDate\": \"<dateTime>\",\n \"frequency\": \"Weekly|Bimonthly|Monthly|Quarterly|Semiannually|Annually|Biennially\",\n \"amount\": \"<double>\",\n \"nextExpectedPaymentDate\": \"<dateTime>\",\n \"anticipatedEndDate\": \"<dateTime>\",\n \"thankYouDate\": \"<dateTime>\",\n \"segmentId\": \"<integer>\",\n \"automatedPayments\": \"<boolean>\",\n \"trackPayments\": \"<boolean>\",\n \"isPrivate\": \"<boolean>\",\n \"designations\": [\n {\n \"projectId\": \"<integer>\",\n \"amountDesignated\": \"<double>\"\n },\n {\n \"projectId\": \"<integer>\",\n \"amountDesignated\": \"<double>\"\n }\n ],\n \"customFields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyconst url = 'https://api.virtuoussoftware.com/api/RecurringGift';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contactId: '<integer>',
startDate: '<dateTime>',
frequency: 'Weekly|Bimonthly|Monthly|Quarterly|Semiannually|Annually|Biennially',
amount: '<double>',
nextExpectedPaymentDate: '<dateTime>',
anticipatedEndDate: '<dateTime>',
thankYouDate: '<dateTime>',
segmentId: '<integer>',
automatedPayments: '<boolean>',
trackPayments: '<boolean>',
isPrivate: '<boolean>',
designations: [
{projectId: '<integer>', amountDesignated: '<double>'},
{projectId: '<integer>', amountDesignated: '<double>'}
],
customFields: [
{name: '<string>', value: '<string>', displayName: '<string>'},
{name: '<string>', value: '<string>', displayName: '<string>'}
]
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"id": 700124,
"transactionSource": null,
"transactionId": null,
"contactId": 101245,
"startDate": "2025-11-15T00:00:00Z",
"amount": 25,
"frequency": "Monthly",
"anticipatedEndDate": null,
"cancelDateTimeUtc": null,
"createDateTimeUtc": "2025-11-15T16:20:09Z",
"createdByUser": "Partner Integration",
"modifiedDateTimeUtc": "2025-11-15T16:20:09Z",
"modifiedByUser": "Partner Integration",
"segmentId": null,
"segment": null,
"segmentUrl": null,
"automatedPayments": true,
"trackPayments": true,
"isPrivate": false,
"status": "Active",
"nextExpectedPaymentDate": "2025-12-15T00:00:00Z",
"designations": [
{
"projectId": 1001,
"project": "General Fund",
"projectUrl": "https://api.virtuoussoftware.com/api/Project/1001",
"amountDesignated": 25,
"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
Create a Recurring Gift
Records a recurring gift on a contact — a commitment to give on a schedule. Set automatedPayments when payments are collected by an external processor, and trackPayments to have Virtuous expect a payment each period so missed ones surface.
POST
/
api
/
RecurringGift
Create a Recurring Gift
curl --request POST \
--url https://api.virtuoussoftware.com/api/RecurringGift \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contactId": "<integer>",
"startDate": "<dateTime>",
"frequency": "Weekly|Bimonthly|Monthly|Quarterly|Semiannually|Annually|Biennially",
"amount": "<double>",
"nextExpectedPaymentDate": "<dateTime>",
"anticipatedEndDate": "<dateTime>",
"thankYouDate": "<dateTime>",
"segmentId": "<integer>",
"automatedPayments": "<boolean>",
"trackPayments": "<boolean>",
"isPrivate": "<boolean>",
"designations": [
{
"projectId": "<integer>",
"amountDesignated": "<double>"
},
{
"projectId": "<integer>",
"amountDesignated": "<double>"
}
],
"customFields": [
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
},
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contactId: '<integer>',
startDate: '<dateTime>',
frequency: 'Weekly|Bimonthly|Monthly|Quarterly|Semiannually|Annually|Biennially',
amount: '<double>',
nextExpectedPaymentDate: '<dateTime>',
anticipatedEndDate: '<dateTime>',
thankYouDate: '<dateTime>',
segmentId: '<integer>',
automatedPayments: '<boolean>',
trackPayments: '<boolean>',
isPrivate: '<boolean>',
designations: [
{projectId: '<integer>', amountDesignated: '<double>'},
{projectId: '<integer>', amountDesignated: '<double>'}
],
customFields: [
{name: '<string>', value: '<string>', displayName: '<string>'},
{name: '<string>', value: '<string>', displayName: '<string>'}
]
})
};
fetch('https://api.virtuoussoftware.com/api/RecurringGift', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/RecurringGift"
payload = {
"contactId": "<integer>",
"startDate": "<dateTime>",
"frequency": "Weekly|Bimonthly|Monthly|Quarterly|Semiannually|Annually|Biennially",
"amount": "<double>",
"nextExpectedPaymentDate": "<dateTime>",
"anticipatedEndDate": "<dateTime>",
"thankYouDate": "<dateTime>",
"segmentId": "<integer>",
"automatedPayments": "<boolean>",
"trackPayments": "<boolean>",
"isPrivate": "<boolean>",
"designations": [
{
"projectId": "<integer>",
"amountDesignated": "<double>"
},
{
"projectId": "<integer>",
"amountDesignated": "<double>"
}
],
"customFields": [
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
},
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.virtuoussoftware.com/api/RecurringGift");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"contactId\": \"<integer>\",\n \"startDate\": \"<dateTime>\",\n \"frequency\": \"Weekly|Bimonthly|Monthly|Quarterly|Semiannually|Annually|Biennially\",\n \"amount\": \"<double>\",\n \"nextExpectedPaymentDate\": \"<dateTime>\",\n \"anticipatedEndDate\": \"<dateTime>\",\n \"thankYouDate\": \"<dateTime>\",\n \"segmentId\": \"<integer>\",\n \"automatedPayments\": \"<boolean>\",\n \"trackPayments\": \"<boolean>\",\n \"isPrivate\": \"<boolean>\",\n \"designations\": [\n {\n \"projectId\": \"<integer>\",\n \"amountDesignated\": \"<double>\"\n },\n {\n \"projectId\": \"<integer>\",\n \"amountDesignated\": \"<double>\"\n }\n ],\n \"customFields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n }\n ]\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.virtuoussoftware.com/api/RecurringGift",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'contactId' => '<integer>',
'startDate' => '<dateTime>',
'frequency' => 'Weekly|Bimonthly|Monthly|Quarterly|Semiannually|Annually|Biennially',
'amount' => '<double>',
'nextExpectedPaymentDate' => '<dateTime>',
'anticipatedEndDate' => '<dateTime>',
'thankYouDate' => '<dateTime>',
'segmentId' => '<integer>',
'automatedPayments' => '<boolean>',
'trackPayments' => '<boolean>',
'isPrivate' => '<boolean>',
'designations' => [
[
'projectId' => '<integer>',
'amountDesignated' => '<double>'
],
[
'projectId' => '<integer>',
'amountDesignated' => '<double>'
]
],
'customFields' => [
[
'name' => '<string>',
'value' => '<string>',
'displayName' => '<string>'
],
[
'name' => '<string>',
'value' => '<string>',
'displayName' => '<string>'
]
]
]),
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.post("https://api.virtuoussoftware.com/api/RecurringGift")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contactId\": \"<integer>\",\n \"startDate\": \"<dateTime>\",\n \"frequency\": \"Weekly|Bimonthly|Monthly|Quarterly|Semiannually|Annually|Biennially\",\n \"amount\": \"<double>\",\n \"nextExpectedPaymentDate\": \"<dateTime>\",\n \"anticipatedEndDate\": \"<dateTime>\",\n \"thankYouDate\": \"<dateTime>\",\n \"segmentId\": \"<integer>\",\n \"automatedPayments\": \"<boolean>\",\n \"trackPayments\": \"<boolean>\",\n \"isPrivate\": \"<boolean>\",\n \"designations\": [\n {\n \"projectId\": \"<integer>\",\n \"amountDesignated\": \"<double>\"\n },\n {\n \"projectId\": \"<integer>\",\n \"amountDesignated\": \"<double>\"\n }\n ],\n \"customFields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.virtuoussoftware.com/api/RecurringGift")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contactId\": \"<integer>\",\n \"startDate\": \"<dateTime>\",\n \"frequency\": \"Weekly|Bimonthly|Monthly|Quarterly|Semiannually|Annually|Biennially\",\n \"amount\": \"<double>\",\n \"nextExpectedPaymentDate\": \"<dateTime>\",\n \"anticipatedEndDate\": \"<dateTime>\",\n \"thankYouDate\": \"<dateTime>\",\n \"segmentId\": \"<integer>\",\n \"automatedPayments\": \"<boolean>\",\n \"trackPayments\": \"<boolean>\",\n \"isPrivate\": \"<boolean>\",\n \"designations\": [\n {\n \"projectId\": \"<integer>\",\n \"amountDesignated\": \"<double>\"\n },\n {\n \"projectId\": \"<integer>\",\n \"amountDesignated\": \"<double>\"\n }\n ],\n \"customFields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyconst url = 'https://api.virtuoussoftware.com/api/RecurringGift';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contactId: '<integer>',
startDate: '<dateTime>',
frequency: 'Weekly|Bimonthly|Monthly|Quarterly|Semiannually|Annually|Biennially',
amount: '<double>',
nextExpectedPaymentDate: '<dateTime>',
anticipatedEndDate: '<dateTime>',
thankYouDate: '<dateTime>',
segmentId: '<integer>',
automatedPayments: '<boolean>',
trackPayments: '<boolean>',
isPrivate: '<boolean>',
designations: [
{projectId: '<integer>', amountDesignated: '<double>'},
{projectId: '<integer>', amountDesignated: '<double>'}
],
customFields: [
{name: '<string>', value: '<string>', displayName: '<string>'},
{name: '<string>', value: '<string>', displayName: '<string>'}
]
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"id": 700124,
"transactionSource": null,
"transactionId": null,
"contactId": 101245,
"startDate": "2025-11-15T00:00:00Z",
"amount": 25,
"frequency": "Monthly",
"anticipatedEndDate": null,
"cancelDateTimeUtc": null,
"createDateTimeUtc": "2025-11-15T16:20:09Z",
"createdByUser": "Partner Integration",
"modifiedDateTimeUtc": "2025-11-15T16:20:09Z",
"modifiedByUser": "Partner Integration",
"segmentId": null,
"segment": null,
"segmentUrl": null,
"automatedPayments": true,
"trackPayments": true,
"isPrivate": false,
"status": "Active",
"nextExpectedPaymentDate": "2025-12-15T00:00:00Z",
"designations": [
{
"projectId": 1001,
"project": "General Fund",
"projectUrl": "https://api.virtuoussoftware.com/api/Project/1001",
"amountDesignated": 25,
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The identifier of the contact this record belongs to.
The date the schedule starts.
How often the payment recurs, for example Monthly, Quarterly, or Annually.
The amount of each scheduled payment.
The date the next payment is expected.
The date the schedule is expected to end, if it is not open ended.
The date the donor was thanked.
The identifier of the segment this record is attributed to.
When true, payments are collected automatically by an external processor rather than entered by hand.
When true, gifts are matched against this schedule so that missed payments can be reported.
When true, the record is only visible to users with permission to view private records.
How the amount is split across projects. The designated amounts must add up to the total amount.
Show child attributes
Show child attributes
Custom field values to set on the record. Field names must match custom fields configured for the organization.
Show child attributes
Show child attributes
Response
OK
The unique identifier of the record in Virtuous.
The external system the record was imported from.
The identifier of this record in the source system.
The identifier of the contact this record belongs to.
The UTC date and time the record was created.
The name of the user who created the record.
The UTC date and time the record was last modified.
The name of the user who last modified the record.
The identifier of the segment this record is attributed to.
A link to the related segment.
When true, the record is only visible to users with permission to view private records.
Show child attributes
Show child attributes
The custom field values stored on the record.
Show child attributes
Show child attributes
Last modified on August 11, 2026
Was this page helpful?
⌘I