Get a specific recurring gift by ID.

GET

https://prod-api.raisedonors.com/api/RecurringGift/:id

GET

/api/RecurringGift/:id

curl https://prod-api.raisedonors.com/api/RecurringGift/1 \
     -H "Authorization: <apiKey>"

{
  "id": 1,
  "organizationId": 1,
  "createdDate": "string",
  "modifiedDate": "string",
  "profileNumber": "string",
  "amount": 1.1,
  "currencyCode": "string",
  "baseCurrencyCode": "string",
  "formattedAmount": "string",
  "donor": {
    "id": 1,
    "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",
      "addressType": 0,
      "addressTypeDisplay": "string",
      "city": "string",
      "countryString": "string",
      "donorId": 1,
      "id": 1,
      "isPrimary": true,
      "postal": "string",
      "state": "string"
    },
    "donorAddresses": [
      {
        "address1": "string",
        "address2": "string",
        "addressType": 0,
        "addressTypeDisplay": "string",
        "city": "string",
        "countryString": "string",
        "donorId": 1,
        "id": 1,
        "isPrimary": true,
        "postal": "string",
        "state": "string"
      }
    ],
    "donorEmailAddresses": [
      {
        "id": 1,
        "donorId": 1,
        "type": 0,
        "typeDisplay": "string",
        "value": "string",
        "secondaryValue": "string",
        "isPrimary": true,
        "isOptedIn": true,
        "isValid": true,
        "isEmail": true,
        "isPhone": true,
        "isBounced": true,
        "countryCode": "string"
      }
    ],
    "donorPhoneNumbers": [
      {
        "id": 1,
        "donorId": 1,
        "type": 0,
        "typeDisplay": "string",
        "value": "string",
        "secondaryValue": "string",
        "isPrimary": true,
        "isOptedIn": true,
        "isValid": true,
        "isEmail": true,
        "isPhone": true,
        "isBounced": true,
        "countryCode": "string"
      }
    ]
  },
  "frequency": 0,
  "formattedFrequency": "string",
  "total": 1.1,
  "formattedTotal": "string",
  "successfulCycles": 1,
  "startDate": "2024-01-15T09:30:00Z",
  "startDateFormatted": "string",
  "nextChargeDate": "2024-01-15T09:30:00Z",
  "nextChargeDateFormatted": "string",
  "nextChargeDateEditFormatted": "string",
  "status": 1,
  "statusText": "string",
  "gatewayId": 1,
  "gateway": "string",
  "paymentInfo": "string",
  "expMonthAndYear": "string",
  "cardBrand": "string",
  "paymentMethodCountryCode": "string",
  "projectAllocation": [
    {
      "projectId": 1,
      "projectName": "string",
      "amount": 1.1,
      "formattedAmount": "string"
    }
  ],
  "isAnonymous": true,
  "isTestMode": true,
  "donorCoverCosts": true,
  "motivationCode": "string",
  "sourceCode": "string",
  "segmentId": 1,
  "segmentName": "string",
  "segmentCode": "string",
  "notes": "string",
  "comments": "string",
  "premium": {
    "id": 1,
    "currency": "string",
    "name": "string",
    "nameShort": "string",
    "code": "string",
    "description": "string",
    "isActive": true,
    "price": 1.1,
    "formattedPrice": "string",
    "fairMarketValue": 1.1,
    "formattedFairMarketValue": "string",
    "inventory": 1,
    "keepActiveWhenHasNoInventory": true,
    "recurringPremiumId": 1,
    "recurringPremiumName": "string",
    "image": "string",
    "externalIdentifier": "string",
    "otherMinimumAmounts": [
      {
        "currency": "string",
        "value": 1.1
      }
    ]
  },
  "recurringPremium": {
    "id": 1,
    "currency": "string",
    "name": "string",
    "nameShort": "string",
    "code": "string",
    "description": "string",
    "isActive": true,
    "price": 1.1,
    "formattedPrice": "string",
    "fairMarketValue": 1.1,
    "formattedFairMarketValue": "string",
    "inventory": 1,
    "keepActiveWhenHasNoInventory": true,
    "recurringPremiumId": 1,
    "recurringPremiumName": "string",
    "image": "string",
    "externalIdentifier": "string",
    "otherMinimumAmounts": [
      {
        "currency": "string",
        "value": 1.1
      }
    ]
  },
  "paymentProviderType": 0,
  "crmKey": "string",
  "crmKeyUrls": {},
  "page": {
    "id": 1,
    "name": "string",
    "internalName": "string",
    "internalDisplayName": "string",
    "slug": "string",
    "isPublished": true,
    "publicId": "string",
    "type": 0,
    "typeDisplayName": "string",
    "formType": 0,
    "externalReferenceId": "string",
    "json": "string",
    "gatewayId": 1,
    "merchantAccount": "string",
    "merchantType": 0,
    "tokenizationKey": "string",
    "payPalGatewayId": 1,
    "payPalMerchantAccount": "string",
    "payPalTokenizationKey": "string",
    "defaultSegmentId": 1,
    "defaultSegmentName": "string",
    "defaultSegmentCode": "string",
    "defaultLanguage": "string",
    "isTranslationEnabled": true,
    "isAIGenerated": true,
    "defaultCampaignId": 1,
    "defaultProjectId": 1,
    "defaultProjectName": "string",
    "defaultProjectCode": "string",
    "isExpireEnabled": true,
    "expireDateTimeUtc": "2024-01-15T09:30:00Z",
    "redirectPageId": 1,
    "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": 1,
        "name": "string",
        "publicKey": "string",
        "integrationType": 0
      }
    ],
    "confirmationEmailId": 1,
    "confirmationEmailName": "string",
    "recurringEmailId": 1,
    "recurringEmailName": "string",
    "acknowledgementEmailId": 1,
    "acknowledgementEmailName": "string",
    "achSettlementConfirmationId": 1,
    "achSettlementConfirmationName": "string",
    "hasMinAmount": true,
    "minAmount": 1.1,
    "minAmountMessage": "string",
    "hasExperiment": true,
    "pageExperimentId": 1,
    "experimentStatus": 0,
    "createdDateTime": "string",
    "modifiedDateTime": "string"
  },
  "merchantType": 0,
  "merchantAccount": "string",
  "tokenizationKey": "string",
  "paymentTenderType": 0,
  "gatewayCustomerKey": "string",
  "hasPaymentFailed": true,
  "isLegacy": true,
  "currencyExchange": {
    "nativeAmount": "string",
    "nativeCurrencyCode": "string",
    "settledExchangeRate": 1.1,
    "settledAmount": "string",
    "settledCurrencyCode": "string",
    "baseExchangeRate": 1.1,
    "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": 1.1
}

Authentication

Authorizationstring

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

Path parameters

idlongRequired

The ID of the recurring gift.

Response

idlongOptional

Gets or sets the unique identifier for the recurring gift.

organizationIdlongOptional

Gets or sets the organization identifier.

createdDatestring or nullOptional

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

modifiedDatestring or nullOptional

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

profileNumberstring or nullOptional

Gets or sets the profile number for the recurring gift.

amountdoubleOptional

Gets or sets the recurring gift amount.

currencyCodestring or nullOptional

Gets or sets the currency code for the recurring gift.

baseCurrencyCodestring or nullOptional

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

formattedAmountstring or nullOptionalRead-only

Gets the formatted recurring gift amount.

donorobject or nullOptional

Gets or sets the donor associated with the recurring gift.

frequencyenumOptional

Gets or sets the frequency of the recurring gift.

formattedFrequencystring or nullOptionalRead-only

Gets the formatted frequency display value.

totaldoubleOptional

Gets or sets the total amount for the recurring gift.

formattedTotalstring or nullOptional

Gets or sets the formatted total amount.

successfulCyclesintegerOptional

Gets or sets the number of successful cycles.

startDatedatetimeOptional

Gets or sets the start date of the recurring gift.

startDateFormattedstring or nullOptionalRead-only

Gets the formatted start date (localized).

nextChargeDatedatetimeOptional

Gets or sets the next charge date.

nextChargeDateFormattedstring or nullOptionalRead-only

Gets the formatted next charge date.

nextChargeDateEditFormattedstring or nullOptionalRead-only

Gets the next charge date formatted for editing.

statusenumOptional

Gets or sets the status of the recurring gift.

statusTextstring or nullOptional

Gets or sets the display text for the status.

gatewayIdlong or nullOptional

Gets or sets the gateway identifier.

gatewaystring or nullOptional

Gets or sets the gateway name.

paymentInfostring or nullOptional

Gets or sets the payment information summary.

expMonthAndYearstring or nullOptional

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

cardBrandstring or nullOptional

Gets or sets the card brand.

paymentMethodCountryCodestring or nullOptional

Gets or sets the payment method country code.

projectAllocationlist of objects or nullOptional

Gets or sets the project allocations for the recurring gift.

isAnonymousbooleanOptional

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

isTestModebooleanOptional

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

donorCoverCostsbooleanOptional

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

motivationCodestring or nullOptional

Gets or sets the motivation code.

sourceCodestring or nullOptional

Gets or sets the source code.

segmentIdlong or nullOptional

Gets or sets the segment identifier.

segmentNamestring or nullOptional

Gets or sets the segment name.

segmentCodestring or nullOptional

Gets or sets the segment code.

notesstring or nullOptional

Gets or sets the notes for the recurring gift.

commentsstring or nullOptional

Gets or sets the comments for the recurring gift.

premiumobject or nullOptional

Gets or sets the premium model associated with the gift.

recurringPremiumobject or nullOptional

Gets or sets the recurring premium model.

paymentProviderTypeenum or nullOptional

Gets or sets the payment provider type.

crmKeystring or nullOptional

Gets or sets the CRM key.

crmKeyUrlsmap from strings to objects or nullOptional

Gets or sets the CRM key URLs.

pageobject or nullOptional

Gets or sets the page response model.

merchantTypeenumOptional

Gets or sets the merchant type.

merchantAccountstring or nullOptional

Gets or sets the merchant account identifier.

tokenizationKeystring or nullOptional

Gets or sets the tokenization key for payment processing.

paymentTenderTypeenumOptional

Gets or sets the payment tender type.

gatewayCustomerKeystring or nullOptional

Gets or sets the gateway customer key.

hasPaymentFailedbooleanOptional

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

isLegacybooleanOptional

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

currencyExchangeobject or nullOptional

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

tributeobject or nullOptional

Gets or sets the Tribute for the recurring gift.

paymentMethodIdstring or nullOptional

Gets or sets the payment method identifier.

costsdoubleOptional

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

Errors

404

Not Found Error