Update a Recurring Gift

curl --request PUT \
  --url https://prod-api.raisedonors.com/api/RecurringGift/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nextChargeDate": "2023-11-07T05:31:56Z",
  "gatewayId": 123,
  "profileNumber": "<string>",
  "amount": 123,
  "currencyCode": "<string>",
  "donorId": 123,
  "projects": [
    {
      "projectId": 123,
      "amount": 500000000000.05
    }
  ],
  "donorCoverCosts": true,
  "costs": 123,
  "isAnonymous": true,
  "motivationCodeLegacy": "<string>",
  "sourceCode": "<string>",
  "segmentId": 123,
  "segmentCode": "<string>",
  "premiumId": 123,
  "crmKey": "<string>",
  "notes": "<string>",
  "pageId": 123,
  "virtualTerminalId": 123,
  "paymentMethodId": "<string>",
  "billingAddress": {
    "address1": "<string>",
    "address2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal": "<string>",
    "countryString": "<string>"
  },
  "cardExpMonth": 123,
  "cardExpYear": 123,
  "cardBrand": "<string>",
  "cardNumber": "<string>",
  "total": 123,
  "startDate": "2023-11-07T05:31:56Z",
  "gatewayCustomerKey": "<string>",
  "achNumber": "<string>",
  "achType": "<string>",
  "virtuousDonorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "billingAddressId": 123,
  "shippingAddressId": 123,
  "timeZone": "<string>",
  "campaignId": 123,
  "campaignName": "<string>",
  "successfulCycles": 123,
  "motivationCodeId": 123,
  "motivationCodeGroupId": 123
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    nextChargeDate: '2023-11-07T05:31:56Z',
    gatewayId: 123,
    profileNumber: '<string>',
    amount: 123,
    currencyCode: '<string>',
    donorId: 123,
    projects: [{projectId: 123, amount: 500000000000.05}],
    donorCoverCosts: true,
    costs: 123,
    isAnonymous: true,
    motivationCodeLegacy: '<string>',
    sourceCode: '<string>',
    segmentId: 123,
    segmentCode: '<string>',
    premiumId: 123,
    crmKey: '<string>',
    notes: '<string>',
    pageId: 123,
    virtualTerminalId: 123,
    paymentMethodId: '<string>',
    billingAddress: {
      address1: '<string>',
      address2: '<string>',
      city: '<string>',
      state: '<string>',
      postal: '<string>',
      countryString: '<string>'
    },
    cardExpMonth: 123,
    cardExpYear: 123,
    cardBrand: '<string>',
    cardNumber: '<string>',
    total: 123,
    startDate: '2023-11-07T05:31:56Z',
    gatewayCustomerKey: '<string>',
    achNumber: '<string>',
    achType: '<string>',
    virtuousDonorId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    billingAddressId: 123,
    shippingAddressId: 123,
    timeZone: '<string>',
    campaignId: 123,
    campaignName: '<string>',
    successfulCycles: 123,
    motivationCodeId: 123,
    motivationCodeGroupId: 123
  })
};

fetch('https://prod-api.raisedonors.com/api/RecurringGift/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://prod-api.raisedonors.com/api/RecurringGift/{id}"

payload = {
    "nextChargeDate": "2023-11-07T05:31:56Z",
    "gatewayId": 123,
    "profileNumber": "<string>",
    "amount": 123,
    "currencyCode": "<string>",
    "donorId": 123,
    "projects": [
        {
            "projectId": 123,
            "amount": 500000000000.05
        }
    ],
    "donorCoverCosts": True,
    "costs": 123,
    "isAnonymous": True,
    "motivationCodeLegacy": "<string>",
    "sourceCode": "<string>",
    "segmentId": 123,
    "segmentCode": "<string>",
    "premiumId": 123,
    "crmKey": "<string>",
    "notes": "<string>",
    "pageId": 123,
    "virtualTerminalId": 123,
    "paymentMethodId": "<string>",
    "billingAddress": {
        "address1": "<string>",
        "address2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal": "<string>",
        "countryString": "<string>"
    },
    "cardExpMonth": 123,
    "cardExpYear": 123,
    "cardBrand": "<string>",
    "cardNumber": "<string>",
    "total": 123,
    "startDate": "2023-11-07T05:31:56Z",
    "gatewayCustomerKey": "<string>",
    "achNumber": "<string>",
    "achType": "<string>",
    "virtuousDonorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "billingAddressId": 123,
    "shippingAddressId": 123,
    "timeZone": "<string>",
    "campaignId": 123,
    "campaignName": "<string>",
    "successfulCycles": 123,
    "motivationCodeId": 123,
    "motivationCodeGroupId": 123
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://prod-api.raisedonors.com/api/RecurringGift/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
request.AddJsonBody("{\n  \"nextChargeDate\": \"2023-11-07T05:31:56Z\",\n  \"gatewayId\": 123,\n  \"profileNumber\": \"<string>\",\n  \"amount\": 123,\n  \"currencyCode\": \"<string>\",\n  \"donorId\": 123,\n  \"projects\": [\n    {\n      \"projectId\": 123,\n      \"amount\": 500000000000.05\n    }\n  ],\n  \"donorCoverCosts\": true,\n  \"costs\": 123,\n  \"isAnonymous\": true,\n  \"motivationCodeLegacy\": \"<string>\",\n  \"sourceCode\": \"<string>\",\n  \"segmentId\": 123,\n  \"segmentCode\": \"<string>\",\n  \"premiumId\": 123,\n  \"crmKey\": \"<string>\",\n  \"notes\": \"<string>\",\n  \"pageId\": 123,\n  \"virtualTerminalId\": 123,\n  \"paymentMethodId\": \"<string>\",\n  \"billingAddress\": {\n    \"address1\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postal\": \"<string>\",\n    \"countryString\": \"<string>\"\n  },\n  \"cardExpMonth\": 123,\n  \"cardExpYear\": 123,\n  \"cardBrand\": \"<string>\",\n  \"cardNumber\": \"<string>\",\n  \"total\": 123,\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"gatewayCustomerKey\": \"<string>\",\n  \"achNumber\": \"<string>\",\n  \"achType\": \"<string>\",\n  \"virtuousDonorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"billingAddressId\": 123,\n  \"shippingAddressId\": 123,\n  \"timeZone\": \"<string>\",\n  \"campaignId\": 123,\n  \"campaignName\": \"<string>\",\n  \"successfulCycles\": 123,\n  \"motivationCodeId\": 123,\n  \"motivationCodeGroupId\": 123\n}", false);
var response = await client.PutAsync(request);

Console.WriteLine("{0}", response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://prod-api.raisedonors.com/api/RecurringGift/{id}",
  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([
    'nextChargeDate' => '2023-11-07T05:31:56Z',
    'gatewayId' => 123,
    'profileNumber' => '<string>',
    'amount' => 123,
    'currencyCode' => '<string>',
    'donorId' => 123,
    'projects' => [
        [
                'projectId' => 123,
                'amount' => 500000000000.05
        ]
    ],
    'donorCoverCosts' => true,
    'costs' => 123,
    'isAnonymous' => true,
    'motivationCodeLegacy' => '<string>',
    'sourceCode' => '<string>',
    'segmentId' => 123,
    'segmentCode' => '<string>',
    'premiumId' => 123,
    'crmKey' => '<string>',
    'notes' => '<string>',
    'pageId' => 123,
    'virtualTerminalId' => 123,
    'paymentMethodId' => '<string>',
    'billingAddress' => [
        'address1' => '<string>',
        'address2' => '<string>',
        'city' => '<string>',
        'state' => '<string>',
        'postal' => '<string>',
        'countryString' => '<string>'
    ],
    'cardExpMonth' => 123,
    'cardExpYear' => 123,
    'cardBrand' => '<string>',
    'cardNumber' => '<string>',
    'total' => 123,
    'startDate' => '2023-11-07T05:31:56Z',
    'gatewayCustomerKey' => '<string>',
    'achNumber' => '<string>',
    'achType' => '<string>',
    'virtuousDonorId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'billingAddressId' => 123,
    'shippingAddressId' => 123,
    'timeZone' => '<string>',
    'campaignId' => 123,
    'campaignName' => '<string>',
    'successfulCycles' => 123,
    'motivationCodeId' => 123,
    'motivationCodeGroupId' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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://prod-api.raisedonors.com/api/RecurringGift/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"nextChargeDate\": \"2023-11-07T05:31:56Z\",\n  \"gatewayId\": 123,\n  \"profileNumber\": \"<string>\",\n  \"amount\": 123,\n  \"currencyCode\": \"<string>\",\n  \"donorId\": 123,\n  \"projects\": [\n    {\n      \"projectId\": 123,\n      \"amount\": 500000000000.05\n    }\n  ],\n  \"donorCoverCosts\": true,\n  \"costs\": 123,\n  \"isAnonymous\": true,\n  \"motivationCodeLegacy\": \"<string>\",\n  \"sourceCode\": \"<string>\",\n  \"segmentId\": 123,\n  \"segmentCode\": \"<string>\",\n  \"premiumId\": 123,\n  \"crmKey\": \"<string>\",\n  \"notes\": \"<string>\",\n  \"pageId\": 123,\n  \"virtualTerminalId\": 123,\n  \"paymentMethodId\": \"<string>\",\n  \"billingAddress\": {\n    \"address1\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postal\": \"<string>\",\n    \"countryString\": \"<string>\"\n  },\n  \"cardExpMonth\": 123,\n  \"cardExpYear\": 123,\n  \"cardBrand\": \"<string>\",\n  \"cardNumber\": \"<string>\",\n  \"total\": 123,\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"gatewayCustomerKey\": \"<string>\",\n  \"achNumber\": \"<string>\",\n  \"achType\": \"<string>\",\n  \"virtuousDonorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"billingAddressId\": 123,\n  \"shippingAddressId\": 123,\n  \"timeZone\": \"<string>\",\n  \"campaignId\": 123,\n  \"campaignName\": \"<string>\",\n  \"successfulCycles\": 123,\n  \"motivationCodeId\": 123,\n  \"motivationCodeGroupId\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod-api.raisedonors.com/api/RecurringGift/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"nextChargeDate\": \"2023-11-07T05:31:56Z\",\n  \"gatewayId\": 123,\n  \"profileNumber\": \"<string>\",\n  \"amount\": 123,\n  \"currencyCode\": \"<string>\",\n  \"donorId\": 123,\n  \"projects\": [\n    {\n      \"projectId\": 123,\n      \"amount\": 500000000000.05\n    }\n  ],\n  \"donorCoverCosts\": true,\n  \"costs\": 123,\n  \"isAnonymous\": true,\n  \"motivationCodeLegacy\": \"<string>\",\n  \"sourceCode\": \"<string>\",\n  \"segmentId\": 123,\n  \"segmentCode\": \"<string>\",\n  \"premiumId\": 123,\n  \"crmKey\": \"<string>\",\n  \"notes\": \"<string>\",\n  \"pageId\": 123,\n  \"virtualTerminalId\": 123,\n  \"paymentMethodId\": \"<string>\",\n  \"billingAddress\": {\n    \"address1\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postal\": \"<string>\",\n    \"countryString\": \"<string>\"\n  },\n  \"cardExpMonth\": 123,\n  \"cardExpYear\": 123,\n  \"cardBrand\": \"<string>\",\n  \"cardNumber\": \"<string>\",\n  \"total\": 123,\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"gatewayCustomerKey\": \"<string>\",\n  \"achNumber\": \"<string>\",\n  \"achType\": \"<string>\",\n  \"virtuousDonorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"billingAddressId\": 123,\n  \"shippingAddressId\": 123,\n  \"timeZone\": \"<string>\",\n  \"campaignId\": 123,\n  \"campaignName\": \"<string>\",\n  \"successfulCycles\": 123,\n  \"motivationCodeId\": 123,\n  \"motivationCodeGroupId\": 123\n}"

response = http.request(request)
puts response.read_body

const url = 'https://prod-api.raisedonors.com/api/RecurringGift/{id}';
const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    nextChargeDate: '2023-11-07T05:31:56Z',
    gatewayId: 123,
    profileNumber: '<string>',
    amount: 123,
    currencyCode: '<string>',
    donorId: 123,
    projects: [{projectId: 123, amount: 500000000000.05}],
    donorCoverCosts: true,
    costs: 123,
    isAnonymous: true,
    motivationCodeLegacy: '<string>',
    sourceCode: '<string>',
    segmentId: 123,
    segmentCode: '<string>',
    premiumId: 123,
    crmKey: '<string>',
    notes: '<string>',
    pageId: 123,
    virtualTerminalId: 123,
    paymentMethodId: '<string>',
    billingAddress: {
      address1: '<string>',
      address2: '<string>',
      city: '<string>',
      state: '<string>',
      postal: '<string>',
      countryString: '<string>'
    },
    cardExpMonth: 123,
    cardExpYear: 123,
    cardBrand: '<string>',
    cardNumber: '<string>',
    total: 123,
    startDate: '2023-11-07T05:31:56Z',
    gatewayCustomerKey: '<string>',
    achNumber: '<string>',
    achType: '<string>',
    virtuousDonorId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    billingAddressId: 123,
    shippingAddressId: 123,
    timeZone: '<string>',
    campaignId: 123,
    campaignName: '<string>',
    successfulCycles: 123,
    motivationCodeId: 123,
    motivationCodeGroupId: 123
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "id": 700089,
  "organizationId": 50,
  "createdDate": "2023-02-15T10:30:00Z",
  "modifiedDate": "2025-11-15T03:00:00Z",
  "profileNumber": "RG-700089",
  "amount": 50,
  "currencyCode": "USD",
  "baseCurrencyCode": "USD",
  "formattedAmount": "$50.00",
  "donor": {
    "id": 200456,
    "name": "Priya Sharma",
    "title": "Ms.",
    "firstName": "Priya",
    "middleName": null,
    "lastName": "Sharma",
    "suffix": null,
    "email": "priya.sharma@example.org",
    "phone": "(555) 012-3450",
    "createdDate": "2023-02-15T10:30:00Z",
    "modifiedDate": "2025-11-15T03:00:00Z",
    "notes": "Monthly donor since February 2023. Volunteer organizer.",
    "isOrganization": false,
    "organizationName": null,
    "crmKeyUrls": {
      "VirtuousCRM": {
        "crmKey": "100456",
        "url": "https://app.virtuoussoftware.com/Generosity/Contact/Detail/100456"
      }
    },
    "crmKey": "100456",
    "crmSecondKey": null,
    "isTestMode": false,
    "isArchived": false,
    "isGDPRDeleted": false,
    "primaryAddress": {
      "id": 400156,
      "donorId": 200456,
      "isPrimary": true,
      "address1": "1542 Elmwood Lane",
      "address2": null,
      "city": "Springfield",
      "state": "OR",
      "postal": "97477",
      "countryString": "United States",
      "addressTypeDisplay": "Home"
    },
    "donorAddresses": [
      {
        "id": 400156,
        "donorId": 200456,
        "isPrimary": true,
        "address1": "1542 Elmwood Lane",
        "address2": null,
        "city": "Springfield",
        "state": "OR",
        "postal": "97477",
        "countryString": "United States",
        "addressTypeDisplay": "Home"
      }
    ],
    "donorEmailAddresses": [
      {
        "id": 300156,
        "donorId": 200456,
        "typeDisplay": "Home Email",
        "value": "priya.sharma@example.org",
        "secondaryValue": null,
        "isPrimary": true,
        "isOptedIn": true,
        "isValid": true,
        "isEmail": true,
        "isPhone": false,
        "isBounced": false,
        "countryCode": null
      }
    ],
    "donorPhoneNumbers": [
      {
        "id": 300157,
        "donorId": 200456,
        "typeDisplay": "Mobile Phone",
        "value": "(555) 012-3450",
        "secondaryValue": null,
        "isPrimary": true,
        "isOptedIn": true,
        "isValid": true,
        "isEmail": false,
        "isPhone": true,
        "isBounced": false,
        "countryCode": "1"
      }
    ]
  },
  "formattedFrequency": "Monthly",
  "total": 1700,
  "formattedTotal": "$1,700.00",
  "successfulCycles": 34,
  "startDate": "2023-02-15T00:00:00Z",
  "startDateFormatted": "February 15, 2023",
  "nextChargeDate": "2025-12-15T00:00:00Z",
  "nextChargeDateFormatted": "December 15, 2025",
  "statusText": "Active",
  "gatewayId": 4180,
  "gateway": "Riverside Hope — Stripe",
  "paymentInfo": "Visa •••• 4242",
  "expMonthAndYear": "04/2027",
  "cardBrand": "Visa",
  "paymentMethodCountryCode": "US",
  "projectAllocation": [
    {
      "projectId": 3010,
      "projectName": "General Operating Support",
      "amount": 50,
      "formattedAmount": "$50.00"
    }
  ],
  "isAnonymous": false,
  "isTestMode": false,
  "donorCoverCosts": false,
  "motivationCode": "MGS-WEB",
  "sourceCode": "monthly-giving-society",
  "segmentId": null,
  "segmentName": null,
  "segmentCode": null,
  "notes": "Monthly Giving Society member since February 2023.",
  "comments": null,
  "premium": null,
  "crmKey": "700089",
  "crmKeyUrls": {},
  "merchantAccount": "riverside-hope-usd",
  "hasPaymentFailed": false,
  "isLegacy": false,
  "currencyExchange": null,
  "tribute": null,
  "paymentMethodId": "pm_1QU4cxHs1Yb4Lm7B",
  "costs": 1.75
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": {
    "amount": [
      "Amount must be greater than zero."
    ]
  },
  "instance": "/api/RecurringGift/700089"
}

{
  "type": "https://tools.ietf.org/html/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 401,
  "detail": "The Authorization header is missing, malformed, or carries a token that is expired or revoked.",
  "instance": "/api/RecurringGift/{id}"
}

PUT

https://prod-api.raisedonors.com

api

RecurringGift

{id}

Update a Recurring Gift

curl --request PUT \
  --url https://prod-api.raisedonors.com/api/RecurringGift/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nextChargeDate": "2023-11-07T05:31:56Z",
  "gatewayId": 123,
  "profileNumber": "<string>",
  "amount": 123,
  "currencyCode": "<string>",
  "donorId": 123,
  "projects": [
    {
      "projectId": 123,
      "amount": 500000000000.05
    }
  ],
  "donorCoverCosts": true,
  "costs": 123,
  "isAnonymous": true,
  "motivationCodeLegacy": "<string>",
  "sourceCode": "<string>",
  "segmentId": 123,
  "segmentCode": "<string>",
  "premiumId": 123,
  "crmKey": "<string>",
  "notes": "<string>",
  "pageId": 123,
  "virtualTerminalId": 123,
  "paymentMethodId": "<string>",
  "billingAddress": {
    "address1": "<string>",
    "address2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal": "<string>",
    "countryString": "<string>"
  },
  "cardExpMonth": 123,
  "cardExpYear": 123,
  "cardBrand": "<string>",
  "cardNumber": "<string>",
  "total": 123,
  "startDate": "2023-11-07T05:31:56Z",
  "gatewayCustomerKey": "<string>",
  "achNumber": "<string>",
  "achType": "<string>",
  "virtuousDonorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "billingAddressId": 123,
  "shippingAddressId": 123,
  "timeZone": "<string>",
  "campaignId": 123,
  "campaignName": "<string>",
  "successfulCycles": 123,
  "motivationCodeId": 123,
  "motivationCodeGroupId": 123
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    nextChargeDate: '2023-11-07T05:31:56Z',
    gatewayId: 123,
    profileNumber: '<string>',
    amount: 123,
    currencyCode: '<string>',
    donorId: 123,
    projects: [{projectId: 123, amount: 500000000000.05}],
    donorCoverCosts: true,
    costs: 123,
    isAnonymous: true,
    motivationCodeLegacy: '<string>',
    sourceCode: '<string>',
    segmentId: 123,
    segmentCode: '<string>',
    premiumId: 123,
    crmKey: '<string>',
    notes: '<string>',
    pageId: 123,
    virtualTerminalId: 123,
    paymentMethodId: '<string>',
    billingAddress: {
      address1: '<string>',
      address2: '<string>',
      city: '<string>',
      state: '<string>',
      postal: '<string>',
      countryString: '<string>'
    },
    cardExpMonth: 123,
    cardExpYear: 123,
    cardBrand: '<string>',
    cardNumber: '<string>',
    total: 123,
    startDate: '2023-11-07T05:31:56Z',
    gatewayCustomerKey: '<string>',
    achNumber: '<string>',
    achType: '<string>',
    virtuousDonorId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    billingAddressId: 123,
    shippingAddressId: 123,
    timeZone: '<string>',
    campaignId: 123,
    campaignName: '<string>',
    successfulCycles: 123,
    motivationCodeId: 123,
    motivationCodeGroupId: 123
  })
};

fetch('https://prod-api.raisedonors.com/api/RecurringGift/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://prod-api.raisedonors.com/api/RecurringGift/{id}"

payload = {
    "nextChargeDate": "2023-11-07T05:31:56Z",
    "gatewayId": 123,
    "profileNumber": "<string>",
    "amount": 123,
    "currencyCode": "<string>",
    "donorId": 123,
    "projects": [
        {
            "projectId": 123,
            "amount": 500000000000.05
        }
    ],
    "donorCoverCosts": True,
    "costs": 123,
    "isAnonymous": True,
    "motivationCodeLegacy": "<string>",
    "sourceCode": "<string>",
    "segmentId": 123,
    "segmentCode": "<string>",
    "premiumId": 123,
    "crmKey": "<string>",
    "notes": "<string>",
    "pageId": 123,
    "virtualTerminalId": 123,
    "paymentMethodId": "<string>",
    "billingAddress": {
        "address1": "<string>",
        "address2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal": "<string>",
        "countryString": "<string>"
    },
    "cardExpMonth": 123,
    "cardExpYear": 123,
    "cardBrand": "<string>",
    "cardNumber": "<string>",
    "total": 123,
    "startDate": "2023-11-07T05:31:56Z",
    "gatewayCustomerKey": "<string>",
    "achNumber": "<string>",
    "achType": "<string>",
    "virtuousDonorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "billingAddressId": 123,
    "shippingAddressId": 123,
    "timeZone": "<string>",
    "campaignId": 123,
    "campaignName": "<string>",
    "successfulCycles": 123,
    "motivationCodeId": 123,
    "motivationCodeGroupId": 123
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://prod-api.raisedonors.com/api/RecurringGift/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
request.AddJsonBody("{\n  \"nextChargeDate\": \"2023-11-07T05:31:56Z\",\n  \"gatewayId\": 123,\n  \"profileNumber\": \"<string>\",\n  \"amount\": 123,\n  \"currencyCode\": \"<string>\",\n  \"donorId\": 123,\n  \"projects\": [\n    {\n      \"projectId\": 123,\n      \"amount\": 500000000000.05\n    }\n  ],\n  \"donorCoverCosts\": true,\n  \"costs\": 123,\n  \"isAnonymous\": true,\n  \"motivationCodeLegacy\": \"<string>\",\n  \"sourceCode\": \"<string>\",\n  \"segmentId\": 123,\n  \"segmentCode\": \"<string>\",\n  \"premiumId\": 123,\n  \"crmKey\": \"<string>\",\n  \"notes\": \"<string>\",\n  \"pageId\": 123,\n  \"virtualTerminalId\": 123,\n  \"paymentMethodId\": \"<string>\",\n  \"billingAddress\": {\n    \"address1\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postal\": \"<string>\",\n    \"countryString\": \"<string>\"\n  },\n  \"cardExpMonth\": 123,\n  \"cardExpYear\": 123,\n  \"cardBrand\": \"<string>\",\n  \"cardNumber\": \"<string>\",\n  \"total\": 123,\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"gatewayCustomerKey\": \"<string>\",\n  \"achNumber\": \"<string>\",\n  \"achType\": \"<string>\",\n  \"virtuousDonorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"billingAddressId\": 123,\n  \"shippingAddressId\": 123,\n  \"timeZone\": \"<string>\",\n  \"campaignId\": 123,\n  \"campaignName\": \"<string>\",\n  \"successfulCycles\": 123,\n  \"motivationCodeId\": 123,\n  \"motivationCodeGroupId\": 123\n}", false);
var response = await client.PutAsync(request);

Console.WriteLine("{0}", response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://prod-api.raisedonors.com/api/RecurringGift/{id}",
  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([
    'nextChargeDate' => '2023-11-07T05:31:56Z',
    'gatewayId' => 123,
    'profileNumber' => '<string>',
    'amount' => 123,
    'currencyCode' => '<string>',
    'donorId' => 123,
    'projects' => [
        [
                'projectId' => 123,
                'amount' => 500000000000.05
        ]
    ],
    'donorCoverCosts' => true,
    'costs' => 123,
    'isAnonymous' => true,
    'motivationCodeLegacy' => '<string>',
    'sourceCode' => '<string>',
    'segmentId' => 123,
    'segmentCode' => '<string>',
    'premiumId' => 123,
    'crmKey' => '<string>',
    'notes' => '<string>',
    'pageId' => 123,
    'virtualTerminalId' => 123,
    'paymentMethodId' => '<string>',
    'billingAddress' => [
        'address1' => '<string>',
        'address2' => '<string>',
        'city' => '<string>',
        'state' => '<string>',
        'postal' => '<string>',
        'countryString' => '<string>'
    ],
    'cardExpMonth' => 123,
    'cardExpYear' => 123,
    'cardBrand' => '<string>',
    'cardNumber' => '<string>',
    'total' => 123,
    'startDate' => '2023-11-07T05:31:56Z',
    'gatewayCustomerKey' => '<string>',
    'achNumber' => '<string>',
    'achType' => '<string>',
    'virtuousDonorId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'billingAddressId' => 123,
    'shippingAddressId' => 123,
    'timeZone' => '<string>',
    'campaignId' => 123,
    'campaignName' => '<string>',
    'successfulCycles' => 123,
    'motivationCodeId' => 123,
    'motivationCodeGroupId' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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://prod-api.raisedonors.com/api/RecurringGift/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"nextChargeDate\": \"2023-11-07T05:31:56Z\",\n  \"gatewayId\": 123,\n  \"profileNumber\": \"<string>\",\n  \"amount\": 123,\n  \"currencyCode\": \"<string>\",\n  \"donorId\": 123,\n  \"projects\": [\n    {\n      \"projectId\": 123,\n      \"amount\": 500000000000.05\n    }\n  ],\n  \"donorCoverCosts\": true,\n  \"costs\": 123,\n  \"isAnonymous\": true,\n  \"motivationCodeLegacy\": \"<string>\",\n  \"sourceCode\": \"<string>\",\n  \"segmentId\": 123,\n  \"segmentCode\": \"<string>\",\n  \"premiumId\": 123,\n  \"crmKey\": \"<string>\",\n  \"notes\": \"<string>\",\n  \"pageId\": 123,\n  \"virtualTerminalId\": 123,\n  \"paymentMethodId\": \"<string>\",\n  \"billingAddress\": {\n    \"address1\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postal\": \"<string>\",\n    \"countryString\": \"<string>\"\n  },\n  \"cardExpMonth\": 123,\n  \"cardExpYear\": 123,\n  \"cardBrand\": \"<string>\",\n  \"cardNumber\": \"<string>\",\n  \"total\": 123,\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"gatewayCustomerKey\": \"<string>\",\n  \"achNumber\": \"<string>\",\n  \"achType\": \"<string>\",\n  \"virtuousDonorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"billingAddressId\": 123,\n  \"shippingAddressId\": 123,\n  \"timeZone\": \"<string>\",\n  \"campaignId\": 123,\n  \"campaignName\": \"<string>\",\n  \"successfulCycles\": 123,\n  \"motivationCodeId\": 123,\n  \"motivationCodeGroupId\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod-api.raisedonors.com/api/RecurringGift/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"nextChargeDate\": \"2023-11-07T05:31:56Z\",\n  \"gatewayId\": 123,\n  \"profileNumber\": \"<string>\",\n  \"amount\": 123,\n  \"currencyCode\": \"<string>\",\n  \"donorId\": 123,\n  \"projects\": [\n    {\n      \"projectId\": 123,\n      \"amount\": 500000000000.05\n    }\n  ],\n  \"donorCoverCosts\": true,\n  \"costs\": 123,\n  \"isAnonymous\": true,\n  \"motivationCodeLegacy\": \"<string>\",\n  \"sourceCode\": \"<string>\",\n  \"segmentId\": 123,\n  \"segmentCode\": \"<string>\",\n  \"premiumId\": 123,\n  \"crmKey\": \"<string>\",\n  \"notes\": \"<string>\",\n  \"pageId\": 123,\n  \"virtualTerminalId\": 123,\n  \"paymentMethodId\": \"<string>\",\n  \"billingAddress\": {\n    \"address1\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postal\": \"<string>\",\n    \"countryString\": \"<string>\"\n  },\n  \"cardExpMonth\": 123,\n  \"cardExpYear\": 123,\n  \"cardBrand\": \"<string>\",\n  \"cardNumber\": \"<string>\",\n  \"total\": 123,\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"gatewayCustomerKey\": \"<string>\",\n  \"achNumber\": \"<string>\",\n  \"achType\": \"<string>\",\n  \"virtuousDonorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"billingAddressId\": 123,\n  \"shippingAddressId\": 123,\n  \"timeZone\": \"<string>\",\n  \"campaignId\": 123,\n  \"campaignName\": \"<string>\",\n  \"successfulCycles\": 123,\n  \"motivationCodeId\": 123,\n  \"motivationCodeGroupId\": 123\n}"

response = http.request(request)
puts response.read_body

const url = 'https://prod-api.raisedonors.com/api/RecurringGift/{id}';
const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    nextChargeDate: '2023-11-07T05:31:56Z',
    gatewayId: 123,
    profileNumber: '<string>',
    amount: 123,
    currencyCode: '<string>',
    donorId: 123,
    projects: [{projectId: 123, amount: 500000000000.05}],
    donorCoverCosts: true,
    costs: 123,
    isAnonymous: true,
    motivationCodeLegacy: '<string>',
    sourceCode: '<string>',
    segmentId: 123,
    segmentCode: '<string>',
    premiumId: 123,
    crmKey: '<string>',
    notes: '<string>',
    pageId: 123,
    virtualTerminalId: 123,
    paymentMethodId: '<string>',
    billingAddress: {
      address1: '<string>',
      address2: '<string>',
      city: '<string>',
      state: '<string>',
      postal: '<string>',
      countryString: '<string>'
    },
    cardExpMonth: 123,
    cardExpYear: 123,
    cardBrand: '<string>',
    cardNumber: '<string>',
    total: 123,
    startDate: '2023-11-07T05:31:56Z',
    gatewayCustomerKey: '<string>',
    achNumber: '<string>',
    achType: '<string>',
    virtuousDonorId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    billingAddressId: 123,
    shippingAddressId: 123,
    timeZone: '<string>',
    campaignId: 123,
    campaignName: '<string>',
    successfulCycles: 123,
    motivationCodeId: 123,
    motivationCodeGroupId: 123
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "id": 700089,
  "organizationId": 50,
  "createdDate": "2023-02-15T10:30:00Z",
  "modifiedDate": "2025-11-15T03:00:00Z",
  "profileNumber": "RG-700089",
  "amount": 50,
  "currencyCode": "USD",
  "baseCurrencyCode": "USD",
  "formattedAmount": "$50.00",
  "donor": {
    "id": 200456,
    "name": "Priya Sharma",
    "title": "Ms.",
    "firstName": "Priya",
    "middleName": null,
    "lastName": "Sharma",
    "suffix": null,
    "email": "priya.sharma@example.org",
    "phone": "(555) 012-3450",
    "createdDate": "2023-02-15T10:30:00Z",
    "modifiedDate": "2025-11-15T03:00:00Z",
    "notes": "Monthly donor since February 2023. Volunteer organizer.",
    "isOrganization": false,
    "organizationName": null,
    "crmKeyUrls": {
      "VirtuousCRM": {
        "crmKey": "100456",
        "url": "https://app.virtuoussoftware.com/Generosity/Contact/Detail/100456"
      }
    },
    "crmKey": "100456",
    "crmSecondKey": null,
    "isTestMode": false,
    "isArchived": false,
    "isGDPRDeleted": false,
    "primaryAddress": {
      "id": 400156,
      "donorId": 200456,
      "isPrimary": true,
      "address1": "1542 Elmwood Lane",
      "address2": null,
      "city": "Springfield",
      "state": "OR",
      "postal": "97477",
      "countryString": "United States",
      "addressTypeDisplay": "Home"
    },
    "donorAddresses": [
      {
        "id": 400156,
        "donorId": 200456,
        "isPrimary": true,
        "address1": "1542 Elmwood Lane",
        "address2": null,
        "city": "Springfield",
        "state": "OR",
        "postal": "97477",
        "countryString": "United States",
        "addressTypeDisplay": "Home"
      }
    ],
    "donorEmailAddresses": [
      {
        "id": 300156,
        "donorId": 200456,
        "typeDisplay": "Home Email",
        "value": "priya.sharma@example.org",
        "secondaryValue": null,
        "isPrimary": true,
        "isOptedIn": true,
        "isValid": true,
        "isEmail": true,
        "isPhone": false,
        "isBounced": false,
        "countryCode": null
      }
    ],
    "donorPhoneNumbers": [
      {
        "id": 300157,
        "donorId": 200456,
        "typeDisplay": "Mobile Phone",
        "value": "(555) 012-3450",
        "secondaryValue": null,
        "isPrimary": true,
        "isOptedIn": true,
        "isValid": true,
        "isEmail": false,
        "isPhone": true,
        "isBounced": false,
        "countryCode": "1"
      }
    ]
  },
  "formattedFrequency": "Monthly",
  "total": 1700,
  "formattedTotal": "$1,700.00",
  "successfulCycles": 34,
  "startDate": "2023-02-15T00:00:00Z",
  "startDateFormatted": "February 15, 2023",
  "nextChargeDate": "2025-12-15T00:00:00Z",
  "nextChargeDateFormatted": "December 15, 2025",
  "statusText": "Active",
  "gatewayId": 4180,
  "gateway": "Riverside Hope — Stripe",
  "paymentInfo": "Visa •••• 4242",
  "expMonthAndYear": "04/2027",
  "cardBrand": "Visa",
  "paymentMethodCountryCode": "US",
  "projectAllocation": [
    {
      "projectId": 3010,
      "projectName": "General Operating Support",
      "amount": 50,
      "formattedAmount": "$50.00"
    }
  ],
  "isAnonymous": false,
  "isTestMode": false,
  "donorCoverCosts": false,
  "motivationCode": "MGS-WEB",
  "sourceCode": "monthly-giving-society",
  "segmentId": null,
  "segmentName": null,
  "segmentCode": null,
  "notes": "Monthly Giving Society member since February 2023.",
  "comments": null,
  "premium": null,
  "crmKey": "700089",
  "crmKeyUrls": {},
  "merchantAccount": "riverside-hope-usd",
  "hasPaymentFailed": false,
  "isLegacy": false,
  "currencyExchange": null,
  "tribute": null,
  "paymentMethodId": "pm_1QU4cxHs1Yb4Lm7B",
  "costs": 1.75
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": {
    "amount": [
      "Amount must be greater than zero."
    ]
  },
  "instance": "/api/RecurringGift/700089"
}

{
  "type": "https://tools.ietf.org/html/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 401,
  "detail": "The Authorization header is missing, malformed, or carries a token that is expired or revoked.",
  "instance": "/api/RecurringGift/{id}"
}

Most often you change its amount, frequency, nextChargeDate, projects allocation, or payment method details. Returns the updated recurring gift.

Send the recurring gift’s full representation, since the request replaces the stored values. To stop the schedule, use Cancel a Recurring Gift rather than changing status here.

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Path Parameters

integer<int64>

required

The ID of the recurring gift.

Body

The recurring gift request model.

Represents a request to create or update a recurring gift.

frequency

enum<integer>

required

The frequency of the recurring gift.

Available options:

0,

1,

2,

4,

12,

26,

52,

100

nextChargeDate

string<date-time>

required

The date of the next scheduled charge.

gatewayId

integer<int64>

required

The unique identifier of the payment gateway to charge through.

profileNumber

string | null

The profile number that identifies the recurring gift at the gateway.

amount

number<double>

The amount of the recurring gift.

currencyCode

string | null

The three-letter ISO currency code the recurring gift is charged in.

donorId

integer<int64>

The unique identifier of the donor the recurring gift belongs to.

status

enum<integer>

The status of the recurring gift.

Available options:

1,

2,

3,

4,

5,

6

projects

object[] | null

The projects associated with the recurring gift.

Show child attributes

donorCoverCosts

boolean

Whether the donor will cover the costs.

costs

number<double>

The costs associated with the recurring gift.

isAnonymous

boolean

Whether the gift was given anonymously.

motivationCodeLegacy

string | null

The motivation code the recurring gift came in under. Use motivationCodeId instead.

sourceCode

string | null

The source code the recurring gift came in under.

segmentId

integer<int64> | null

The unique identifier of the segment to attribute the recurring gift to.

segmentCode

string | null

The code of the segment to attribute the recurring gift to.

premiumId

integer<int64> | null

The unique identifier of the premium to send the donor.

crmKey

string | null

The key that links the recurring gift to the matching record in your CRM.

notes

string | null

Any additional notes to store on the recurring gift.

pageId

integer<int64> | null

The unique identifier of the page the recurring gift was started from.

virtualTerminalId

integer<int64> | null

The unique identifier of the virtual terminal the recurring gift was entered through.

paymentMethodId

string | null

The unique identifier of the stored payment method to charge.

billingAddress

object

The billing address for the payment method.

Option 1
Option 2

Show child attributes

paymentTenderType

enum<integer>

How the donor pays, such as by card or bank account.

Available options:

0,

1,

2,

3,

4,

5,

6,

7,

8,

9,

10,

11,

12,

13,

14

cardExpMonth

integer<int32> | null

The expiration month of the card, from 1 to 12.

cardExpYear

integer<int32> | null

The four-digit expiration year of the card.

cardBrand

string | null

The brand of the card, such as Visa or Mastercard.

cardNumber

string | null

The card number, or its last four digits on a gift that already exists.

total

number<double>

The total amount charged each cycle, including any costs the donor covers.

startDate

string<date-time>

The start date of the recurring gift.

gatewayCustomerKey

string | null

The gateway's identifier for the donor as a customer.

achNumber

string | null

The bank account number for an ACH payment, or its last four digits on a gift that already exists.

achType

string | null

The type of bank account for an ACH payment, such as Checking or Savings.

virtuousDonorId

string<uuid> | null

The unique identifier of the matching contact in Virtuous CRM.

billingAddressId

integer<int64> | null

The unique identifier of the donor address to bill.

shippingAddressId

integer<int64> | null

The unique identifier of the donor address to ship premiums to.

timeZone

string | null

The time zone the charge dates are interpreted in.

campaignId

integer<int64> | null

The unique identifier of the campaign to attribute the recurring gift to.

campaignName

string | null

The name of the campaign to attribute the recurring gift to.

successfulCycles

integer<int32>

The number of cycles already charged successfully, when importing an existing schedule.

motivationCodeId

integer<int64> | null

The unique identifier of the motivation code to attribute the recurring gift to.

motivationCodeGroupId

integer<int64> | null

The unique identifier of the motivation code group to attribute the recurring gift to.

Response

Represents a model for recurring gifts.

integer<int64>

The unique identifier for the recurring gift.

organizationId

integer<int64>

The unique identifier of the organization.

createdDate

string | null

The created date (localized and formatted).

modifiedDate

string | null

The modified date (localized and formatted).

profileNumber

string | null

The profile number for the recurring gift.

amount

number<double>

The amount charged each cycle.

currencyCode

string | null

The currency code for the recurring gift.

baseCurrencyCode

string | null

The base currency code for the recurring gift, if applicable.

formattedAmount

string | null

read-only

The formatted recurring gift amount.

donor

object | null

The donor associated with the recurring gift.

Show child attributes

frequency

enum<integer>

The frequency of the recurring gift.

Available options:

0,

1,

2,

4,

12,

26,

52,

100

formattedFrequency

string | null

read-only

The formatted frequency display value.

total

number<double>

The total amount for the recurring gift.

formattedTotal

string | null

The total amount, formatted for display in its currency.

successfulCycles

integer<int32>

The number of successful cycles.

startDate

string<date-time>

The start date of the recurring gift.

startDateFormatted

string | null

read-only

The formatted start date (localized).

nextChargeDate

string<date-time>

The date of the next scheduled charge.

nextChargeDateFormatted

string | null

read-only

The formatted next charge date.

nextChargeDateEditFormatted

string | null

read-only

The next charge date formatted for editing.

status

enum<integer>

The status of the recurring gift.

Available options:

1,

2,

3,

4,

5,

6

statusText

string | null

The display text for the status.

gatewayId

integer<int64> | null

The unique identifier of the payment gateway the recurring gift is charged through.

gateway

string | null

The name of the payment gateway the recurring gift is charged through.

paymentInfo

string | null

A summary of the payment method being charged.

expMonthAndYear

string | null

The expiration month and year for the card.

cardBrand

string | null

The brand of the card being charged, such as Visa or Mastercard.

paymentMethodCountryCode

string | null

The payment method country code.

projectAllocation

object[] | null

The project allocations for the recurring gift.

Show child attributes

isAnonymous

boolean

Whether the gift was given anonymously.

isTestMode

boolean

Whether the gift is in test mode.

donorCoverCosts

boolean

Whether the donor covers processing costs.

motivationCode

string | null

The motivation code the recurring gift came in under.

sourceCode

string | null

The source code the recurring gift came in under.

segmentId

integer<int64> | null

The unique identifier of the segment.

segmentName

string | null

The name of the segment.

segmentCode

string | null

The code of the segment the gift came in under.

notes

string | null

The notes for the recurring gift.

comments

string | null

The comments for the recurring gift.

premium

object | null

The premium model associated with the gift.

Show child attributes

recurringPremium

object | null

The premium sent to the donor for the recurring gift.

Show child attributes

paymentProviderType

enum<integer> | null

The payment provider the recurring gift is charged through.

Available options:

0,

1,

2,

3,

4,

5,

6,

7

crmKey

string | null

The key that links the recurring gift to the matching record in your CRM.

crmKeyUrls

object | null

Links to the matching records in your CRM, by CRM.

Show child attributes

page

object | null

The page the recurring gift was started from.

Show child attributes

merchantType

enum<integer>

The merchant account type used at the gateway.

Available options:

0,

1,

2,

3,

4,

5

merchantAccount

string | null

The merchant account used at the gateway.

tokenizationKey

string | null

The tokenization key for payment processing.

paymentTenderType

enum<integer>

How the donor pays, such as by card or bank account.

Available options:

0,

1,

2,

3,

4,

5,

6,

7,

8,

9,

10,

11,

12,

13,

14

gatewayCustomerKey

string | null

The gateway's identifier for the donor as a customer.

hasPaymentFailed

boolean

Whether a payment has failed.

isLegacy

boolean

Whether this is a legacy recurring gift.

currencyExchange

object | null

The currency exchange information for the recurring gift, if applicable.

Show child attributes

tribute

object | null

The tribute for the recurring gift.

Show child attributes

paymentMethodId

string | null

The unique identifier of the stored payment method being charged.

costs

number<double>

The processing fee costs covered by the donor.

Last modified on July 28, 2026

⌘I

Activity

Campaign

CustomField

Donor

EmailList

Gift

MotivationCode

OrgKnowledge

Premium

Project

Query

Raise

RecurringGift

Segment

Webhook

Zapier

Update a Recurring Gift

Authorizations

Path Parameters

Body

Response