Changelog
All notable changes to the current API will be documented here. To learn about API versioning, see API lifecycle.
Changes that affect multiple APIs are documented in the general changelog.
January 2026​
Webhook support and agreement details endpoint​
Added webhook support for donation agreements with two new event types:
donations.agreement.started.v1- Triggered when a donation agreement is starteddonations.agreement.stopped.v1- Triggered when a donation agreement is stopped
Added new endpoint GET:/donations/v1/agreements/{agreementId} to retrieve comprehensive details about a specific donation agreement
See API guide: Webhooks integration for more details.
Authentication changes​
The Donations product was released, this changes how authentication is done for new integrations.
We have added merchant level API clients and they are in use on the Donations API.
This means you will get a client id and a client secret in the portal, and you will use that to get your bearer token. Unlike the existing API clients these clients do not have a Subscription Key, and represent a merchant not a sales unit. To get your bearer token use Specialized Authentication.
If you already have integrated based on a Recurring Donations API client it will still work but we recommend moving to the merchant level client once you have been approved for the Donations product.
See API guide: Integrations steps for more details.
October 2025​
Batch limits for payment reports​
Reduced the max amount of payments in a single response from the /donations/v1/reports/payments endpoint to 1000, this value is subject to change and integrations should account for it being dynamic. This change is done to ensure system stability.
This means that responses may not contain all payments within a given time interval, requiring pagination using the latest capturedAt timestamp from each response. Read more in the API guide best practices section.
JUNE 2025​
Added transactionReference to the response for /donations/v1/reports/payments.
This field matches the reference field of the Report API and downloadable reports in the portal.
Added recipientHandles as query parameter for the /donations/v1/reports/payments endpoint. This allows filtering the recipientHandles.
MAY 2025​
Renamed fields in the /donations/v1/reports/payments endpoint​
Deprecated the fromDateTimeUtc and toDateTimeUtc query parameters, new ones are named from and to.
Deprecated the fromDateTimeUtc and toDateTimeUtc fields in the response, new ones are named from and to.
Deprecated the paymentDateTimeUtc field in the response object, new one is called capturedAt.
APRIL 2025​
Made first version of the /donations/v1/reports/payments endpoint available.