Skip to main content
PUT
https://prod-api.raisedonors.com
/
api
/
RecurringGift
/
{id}
/
cancel
Cancel a Recurring Gift
curl --request PUT \
  --url https://prod-api.raisedonors.com/api/RecurringGift/{id}/cancel \
  --header 'Authorization: <api-key>'
{
  "id": 123,
  "organizationId": 123,
  "createdDate": "<string>",
  "modifiedDate": "<string>",
  "profileNumber": "<string>",
  "amount": 123,
  "currencyCode": "<string>",
  "baseCurrencyCode": "<string>",
  "formattedAmount": "<string>",
  "donor": {
    "id": 123,
    "name": "<string>",
    "title": "<string>",
    "firstName": "<string>",
    "middleName": "<string>",
    "lastName": "<string>",
    "suffix": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "createdDate": "<string>",
    "modifiedDate": "<string>",
    "notes": "<string>",
    "isOrganization": true,
    "organizationName": "<string>",
    "crmKeyUrls": {},
    "crmKey": "<string>",
    "crmSecondKey": "<string>",
    "isTestMode": true,
    "isArchived": true,
    "isGDPRDeleted": true,
    "primaryAddress": {
      "address1": "<string>",
      "address2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal": "<string>",
      "countryString": "<string>",
      "addressTypeDisplay": "<string>",
      "id": 123,
      "donorId": 123,
      "isPrimary": true
    },
    "donorAddresses": [
      {
        "address1": "<string>",
        "address2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal": "<string>",
        "countryString": "<string>",
        "addressTypeDisplay": "<string>",
        "id": 123,
        "donorId": 123,
        "isPrimary": true
      }
    ],
    "donorEmailAddresses": [
      {
        "id": 123,
        "donorId": 123,
        "typeDisplay": "<string>",
        "value": "<string>",
        "secondaryValue": "<string>",
        "isPrimary": true,
        "isOptedIn": true,
        "isValid": true,
        "isEmail": true,
        "isPhone": true,
        "isBounced": true,
        "countryCode": "<string>"
      }
    ],
    "donorPhoneNumbers": [
      {
        "id": 123,
        "donorId": 123,
        "typeDisplay": "<string>",
        "value": "<string>",
        "secondaryValue": "<string>",
        "isPrimary": true,
        "isOptedIn": true,
        "isValid": true,
        "isEmail": true,
        "isPhone": true,
        "isBounced": true,
        "countryCode": "<string>"
      }
    ]
  },
  "formattedFrequency": "<string>",
  "total": 123,
  "formattedTotal": "<string>",
  "successfulCycles": 123,
  "startDate": "2023-11-07T05:31:56Z",
  "startDateFormatted": "<string>",
  "nextChargeDate": "2023-11-07T05:31:56Z",
  "nextChargeDateFormatted": "<string>",
  "nextChargeDateEditFormatted": "<string>",
  "statusText": "<string>",
  "gatewayId": 123,
  "gateway": "<string>",
  "paymentInfo": "<string>",
  "expMonthAndYear": "<string>",
  "cardBrand": "<string>",
  "paymentMethodCountryCode": "<string>",
  "projectAllocation": [
    {
      "projectId": 123,
      "projectName": "<string>",
      "amount": 123,
      "formattedAmount": "<string>"
    }
  ],
  "isAnonymous": true,
  "isTestMode": true,
  "donorCoverCosts": true,
  "motivationCode": "<string>",
  "sourceCode": "<string>",
  "segmentId": 123,
  "segmentName": "<string>",
  "segmentCode": "<string>",
  "notes": "<string>",
  "comments": "<string>",
  "premium": {
    "id": 123,
    "currency": "<string>",
    "name": "<string>",
    "nameShort": "<string>",
    "code": "<string>",
    "description": "<string>",
    "isActive": true,
    "price": 123,
    "formattedPrice": "<string>",
    "fairMarketValue": 123,
    "formattedFairMarketValue": "<string>",
    "inventory": 123,
    "keepActiveWhenHasNoInventory": true,
    "recurringPremiumId": 123,
    "recurringPremiumName": "<string>",
    "image": "<string>",
    "externalIdentifier": "<string>",
    "otherMinimumAmounts": [
      {
        "currency": "<string>",
        "value": 123
      }
    ]
  },
  "recurringPremium": {
    "id": 123,
    "currency": "<string>",
    "name": "<string>",
    "nameShort": "<string>",
    "code": "<string>",
    "description": "<string>",
    "isActive": true,
    "price": 123,
    "formattedPrice": "<string>",
    "fairMarketValue": 123,
    "formattedFairMarketValue": "<string>",
    "inventory": 123,
    "keepActiveWhenHasNoInventory": true,
    "recurringPremiumId": 123,
    "recurringPremiumName": "<string>",
    "image": "<string>",
    "externalIdentifier": "<string>",
    "otherMinimumAmounts": [
      {
        "currency": "<string>",
        "value": 123
      }
    ]
  },
  "crmKey": "<string>",
  "crmKeyUrls": {},
  "page": {
    "id": 123,
    "name": "<string>",
    "internalName": "<string>",
    "internalDisplayName": "<string>",
    "slug": "<string>",
    "isPublished": true,
    "publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "typeDisplayName": "<string>",
    "externalReferenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "json": "<string>",
    "gatewayId": 123,
    "merchantAccount": "<string>",
    "tokenizationKey": "<string>",
    "payPalGatewayId": 123,
    "payPalMerchantAccount": "<string>",
    "payPalTokenizationKey": "<string>",
    "defaultSegmentId": 123,
    "defaultSegmentName": "<string>",
    "defaultSegmentCode": "<string>",
    "defaultLanguage": "<string>",
    "isTranslationEnabled": true,
    "isAIGenerated": true,
    "defaultCampaignId": 123,
    "defaultProjectId": 123,
    "defaultProjectName": "<string>",
    "defaultProjectCode": "<string>",
    "isExpireEnabled": true,
    "expireDateTimeUtc": "2023-11-07T05:31:56Z",
    "redirectPageId": 123,
    "redirectPageName": "<string>",
    "redirectUrl": "<string>",
    "autoArchiveOnExpire": true,
    "designSettings": {
      "websiteUrl": "<string>",
      "logoUrl": "<string>",
      "faviconUrl": "<string>",
      "primaryColor": "<string>",
      "secondaryColor": "<string>",
      "backgroundColor": "<string>",
      "headerColor": "<string>",
      "headerTextColor": "<string>",
      "bodyTextColor": "<string>",
      "footerColor": "<string>",
      "footerTextColor": "<string>",
      "buttonColor": "<string>",
      "buttonTextColor": "<string>",
      "buttonHoverColor": "<string>",
      "buttonHoverTextColor": "<string>",
      "linkColor": "<string>",
      "fieldLabelColor": "<string>",
      "fieldBorderColor": "<string>",
      "borderRadius": "<string>",
      "fontFamily": "<string>",
      "globalCss": "<string>",
      "globalJs": "<string>"
    },
    "integrations": [
      {
        "id": 123,
        "name": "<string>",
        "publicKey": "<string>"
      }
    ],
    "confirmationEmailId": 123,
    "confirmationEmailName": "<string>",
    "recurringEmailId": 123,
    "recurringEmailName": "<string>",
    "acknowledgementEmailId": 123,
    "acknowledgementEmailName": "<string>",
    "achSettlementConfirmationId": 123,
    "achSettlementConfirmationName": "<string>",
    "hasMinAmount": true,
    "minAmount": 123,
    "minAmountMessage": "<string>",
    "hasExperiment": true,
    "pageExperimentId": 123,
    "createdDateTime": "<string>",
    "modifiedDateTime": "<string>"
  },
  "merchantAccount": "<string>",
  "tokenizationKey": "<string>",
  "gatewayCustomerKey": "<string>",
  "hasPaymentFailed": true,
  "isLegacy": true,
  "currencyExchange": {
    "nativeAmount": "<string>",
    "nativeCurrencyCode": "<string>",
    "settledExchangeRate": 123,
    "settledAmount": "<string>",
    "settledCurrencyCode": "<string>",
    "baseExchangeRate": 123,
    "baseAmount": "<string>",
    "baseCurrencyCode": "<string>",
    "isDifferentCurrency": true
  },
  "tribute": {
    "isInMemoryOf": true,
    "isInHonorOf": true,
    "nameOrOccasion": "<string>",
    "tributeFirstName": "<string>",
    "tributeLastName": "<string>",
    "tributeAddress1": "<string>",
    "tributeAddress2": "<string>",
    "tributeCity": "<string>",
    "tributeState": "<string>",
    "tributeCountry": "<string>",
    "tributePostal": "<string>",
    "acknowledgeeFirstName": "<string>",
    "acknowledgeeLastName": "<string>",
    "sendByEmail": true,
    "acknowledgeeEmailAddress": "<string>",
    "sendByPostal": true,
    "acknowledgeeAddress1": "<string>",
    "acknowledgeeAddress2": "<string>",
    "acknowledgeeCity": "<string>",
    "acknowledgeeState": "<string>",
    "acknowledgeeCountry": "<string>",
    "acknowledgeePostal": "<string>",
    "message": "<string>"
  },
  "paymentMethodId": "<string>",
  "costs": 123
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
integer<int64>
required

The id of the recurring gift.

Response

OK

Represents a model for recurring gifts.

id
integer<int64>

Gets or sets the unique identifier for the recurring gift.

organizationId
integer<int64>

Gets or sets the organization identifier.

createdDate
string | null

Gets or sets the created date (localized and formatted).

modifiedDate
string | null

Gets or sets the modified date (localized and formatted).

profileNumber
string | null

Gets or sets the profile number for the recurring gift.

amount
number<double>

Gets or sets the recurring gift amount.

currencyCode
string | null

Gets or sets the currency code for the recurring gift.

baseCurrencyCode
string | null

Gets or sets the base currency code for the recurring gift, if applicable.

formattedAmount
string | null
read-only

Gets the formatted recurring gift amount.

donor
object

Gets or sets the donor associated with the recurring gift.

frequency
enum<integer>

Gets or sets the frequency of the recurring gift.

Available options:
0,
1,
2,
4,
12,
26,
52,
100
formattedFrequency
string | null
read-only

Gets the formatted frequency display value.

total
number<double>

Gets or sets the total amount for the recurring gift.

formattedTotal
string | null

Gets or sets the formatted total amount.

successfulCycles
integer<int32>

Gets or sets the number of successful cycles.

startDate
string<date-time>

Gets or sets the start date of the recurring gift.

startDateFormatted
string | null
read-only

Gets the formatted start date (localized).

nextChargeDate
string<date-time>

Gets or sets the next charge date.

nextChargeDateFormatted
string | null
read-only

Gets the formatted next charge date.

nextChargeDateEditFormatted
string | null
read-only

Gets the next charge date formatted for editing.

status
enum<integer>

Gets or sets the status of the recurring gift.

Available options:
1,
2,
3,
4,
5,
6
statusText
string | null

Gets or sets the display text for the status.

gatewayId
integer<int64> | null

Gets or sets the gateway identifier.

gateway
string | null

Gets or sets the gateway name.

paymentInfo
string | null

Gets or sets the payment information summary.

expMonthAndYear
string | null

Gets or sets the expiration month and year for the card.

cardBrand
string | null

Gets or sets the card brand.

paymentMethodCountryCode
string | null

Gets or sets the payment method country code.

projectAllocation
object[] | null

Gets or sets the project allocations for the recurring gift.

isAnonymous
boolean

Gets or sets a value indicating whether the donor is anonymous.

isTestMode
boolean

Gets or sets a value indicating whether the gift is in test mode.

donorCoverCosts
boolean

Gets or sets a value indicating whether the donor covers processing costs.

motivationCode
string | null

Gets or sets the motivation code.

sourceCode
string | null

Gets or sets the source code.

segmentId
integer<int64> | null

Gets or sets the segment identifier.

segmentName
string | null

Gets or sets the segment name.

segmentCode
string | null

Gets or sets the segment code.

notes
string | null

Gets or sets the notes for the recurring gift.

comments
string | null

Gets or sets the comments for the recurring gift.

premium
object

Gets or sets the premium model associated with the gift.

recurringPremium
object

Gets or sets the recurring premium model.

paymentProviderType
enum<integer>

Gets or sets the payment provider type.

Available options:
0,
1,
2,
3,
4,
5,
6,
7
crmKey
string | null

Gets or sets the CRM key.

crmKeyUrls
object

Gets or sets the CRM key URLs.

page
object

Gets or sets the page response model.

merchantType
enum<integer>

Gets or sets the merchant type.

Available options:
0,
1,
2,
3,
4,
5
merchantAccount
string | null

Gets or sets the merchant account identifier.

tokenizationKey
string | null

Gets or sets the tokenization key for payment processing.

paymentTenderType
enum<integer>

Gets or sets the payment tender type.

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14
gatewayCustomerKey
string | null

Gets or sets the gateway customer key.

hasPaymentFailed
boolean

Gets or sets a value indicating whether a payment has failed.

isLegacy
boolean

Gets or sets a value indicating whether this is a legacy recurring gift.

currencyExchange
object

Gets or sets the currency exchange information for the recurring gift, if applicable.

tribute
object

Gets or sets the Tribute for the recurring gift.

paymentMethodId
string | null

Gets or sets the payment method identifier.

costs
number<double>

Gets or sets the processing fee costs covered by the donor.

Last modified on June 5, 2026