Recurring Gift Schedule

Paul Yoder

How do I retrieve the schedule for a recurring gift from the API? It doesn't seem like the ‘Gift' endpoint includes that information.

Matt Thacker

Hey @Paul Yoder, the schedule is on the GET action on the Gift endpoint. It's not listed on the example output but if you go into the schema of the endpoint, it's toward the bottom:

Here's an example of one

Paul Yoder

@Matt Thacker I'm not seeing the “recurring-gift-schedule” property come back from the endpoint. The closest thing I see is “recurring-gift-status-date”

{
"id": "11111",
"acknowledgements": [
{
"status": "NEEDSACKNOWLEDGEMENT"
}
],
"amount": {
"value": 25.0
},
"constituent_id": "0000",
"date": "2021-07-15T00:00:00",
"date_added": "2022-03-09T17:41:06.163-05:00",
"date_modified": "2023-05-01T12:02:45.438-04:00",
"fundraisers": [],
"gift_aid_qualification_status": "NotQualified",
"gift_splits": [
{
"id": "2149432",
"amount": {
"value": 25.0
},
"fund_id": "872"
}
],
"gift_status": "Active",
"is_anonymous": false,
"linked_gifts": [],
"constituency": "Individual",
"lookup_id": "0000",
"payments": [
{
"account_token": "abcd",
"payment_method": "CreditCard"
}
],
"post_date": "2021-07-15T00:00:00",
"post_status": "NotPosted",
"receipts": [
{
"amount": {
"value": 25.0
},
"status": "NEEDSRECEIPT"
}
],
"recurring_gift_status_date": {
"d": 15,
"m": 7,
"y": 2021
},
"soft_credits": [],
"type": "RecurringGift"
}

I noticed your example gift has a “subtype” of “BBMS” but my gift does not have that. Does that have anything to do with the schedule not coming back?

Tim Fox

@Matt Thacker
Hi Matt - I'm having a similar issue as well. I looked at the schema for the gifts list endpoint and both the recurring and schedule date are listed in the schema. However, when I run the API, I do not get those fields back. Are these fields not actually available when pulling back a gift list (ie only work when specifying a specific gift)?

Matt Thacker

Hey @Tim Fox, yes, it appears a lot of those fields are not returned from the Get Gift List endpoint. I believe they've copied the Get Gift endpoint schema for the Get Gift List schema. What I've done to get around this is using the Get Gift List and then iterating through the list hitting the Get Gift endpoint for each one.

Vincent Bailly

@Matt Thacker would you know if it is also on the POST action? Here:

Thanks!