Skip to main content
GET
Get a Recurring Gift
The response covers the amount, frequency, and status, the nextChargeDate and the successfulCycles so far, the payment method and gateway behind it, the projectAllocation each payment is split across, the premium and tribute attached to it, the page it was started from, and the donor who gave it.
hasPaymentFailed flags a schedule that needs attention.

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>

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.

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.

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.

recurringPremium
object | null

The premium sent to the donor for the recurring gift.

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.

page
object | null

The page the recurring gift was started from.

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.

tribute
object | null

The tribute for the recurring gift.

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