Skip to main content
GET
/
api
/
RecurringGift
/
{recurringGiftId}
Get a Recurring Gift
curl --request GET \
  --url https://api.virtuoussoftware.com/api/RecurringGift/{recurringGiftId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<integer>",
  "transactionSource": "<string>",
  "transactionId": "<string>",
  "contactId": "<integer>",
  "startDate": "<dateTime>",
  "amount": "<double>",
  "frequency": "<string>",
  "anticipatedEndDate": "<dateTime>",
  "cancelDateTimeUtc": "<dateTime>",
  "createDateTimeUtc": "<dateTime>",
  "createdByUser": "<string>",
  "modifiedDateTimeUtc": "<dateTime>",
  "modifiedByUser": "<string>",
  "segmentId": "<integer>",
  "segment": "<string>",
  "segmentUrl": "<string>",
  "automatedPayments": "<boolean>",
  "trackPayments": "<boolean>",
  "isPrivate": "<boolean>",
  "status": "<string>",
  "nextExpectedPaymentDate": "<dateTime>",
  "designations": [
    {
      "projectId": "<integer>",
      "project": "<string>",
      "projectUrl": "<string>",
      "amountDesignated": "<double>",
      "projectCode": "<string>"
    },
    {
      "projectId": "<integer>",
      "project": "<string>",
      "projectUrl": "<string>",
      "amountDesignated": "<double>",
      "projectCode": "<string>"
    }
  ],
  "customFields": [
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    },
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

recurringGiftId
string
required

(Required)

Response

OK

id
string
transactionSource
string
transactionId
string
contactId
string
startDate
string
amount
string
frequency
string
anticipatedEndDate
string
cancelDateTimeUtc
string
createDateTimeUtc
string
createdByUser
string
modifiedDateTimeUtc
string
modifiedByUser
string
segmentId
string
segment
string
segmentUrl
string
automatedPayments
string
trackPayments
string
isPrivate
string
status
string
nextExpectedPaymentDate
string
designations
object[]
customFields
object[]
Last modified on June 5, 2026