List recurring donations

• limit#numberin query

  The max number of items to return.

• cursor#stringin query

  The id of the last item from the previous page. Used to fetch the next page.

• createdAt_lt#string (date-time)in query

  Format: YYYY-MM-DDTHH:MM:SSZ.

• createdAt_lte#string (date-time)in query

  Format: YYYY-MM-DDTHH:MM:SSZ.

• createdAt_gt#string (date-time)in query

  Format: YYYY-MM-DDTHH:MM:SSZ.

• createdAt_gte#string (date-time)in query

  Format: YYYY-MM-DDTHH:MM:SSZ.

• campaignId#stringin queryUUID

  Id of one your campaigns

• status#stringin query

  Status of your recurring donations

  PENDINGACTIVEPAUSEDCANCELED

• donorId#stringin queryUUID

  Id of the donor.

• includeMetrics#booleanin query

  Include metrics

• includeCharity#booleanin query

  Include charity

  Required in the spec, optional for the API.

• accountId#stringin queryUUID

  Id of the account. Only useful for Platform customers to filter recurring donations by child accounts.

No field is described in the spec.

• recurringDonationId#stringalways returned

• type#RecurringDonationTypealways returned

  FREQUENCYMANUAL

• amountType#RecurringDonationAmountTypealways returned

  FIXED_AMOUNTRATE

• status#RecurringDonationStatusalways returned

  PENDINGACTIVEPAUSEDCANCELED

• hasBeenCharged#booleanalways returned

• feeType#FeeTypealways returned

  EXCLUDEDINCLUDED

• amount#integer (int64)always returned

• rate#number

• baseAmount#integer (int64)

• withRounding#booleanalways returned

• frequency#string

• secret#stringalways returned

• externalId#string

• uniqueExternalId#string

• sendingMode#CampaignSendingModealways returned

  MANUALEMAILPHYSICALSLACKPOSTAL

• sendingDate#string (date-time)

• sendingStatus#DonationSendingStatusalways returned

  PENDINGFAILEDDONE

• lastReminderId#string

• message#string

• reminderMessage#string

• from#string

• language#Languagealways returned

  fren

• accountId#stringalways returned

• campaignId#stringalways returned

• charityId#string

• donorId#stringalways returned

• createdAt#string (date-time)always returned

• updatedAt#string (date-time)always returned

Errors

• 400A field is missing, has the wrong type, or is not part of the request schema.

  Every request with a body or query is validated.

  {
    "statusCode": 400,
    "message": [
      "amount must not be less than 1",
      "property foo should not exist"
    ],
    "error": "Bad Request"
  }

• 401Unauthorized

  Missing, expired or invalid access token.

  {
    "statusCode": 401,
    "message": "Unauthorized"
  }

• 403Account closed

  {
    "message": "Account closed",
    "code": "ACCOUNT_CLOSED"
  }