f59881dadecd
Get events
This request helps you track updates and changes in your account in the same way as in the Audit Log. While the Donations endpoint shows the current state of a donation when queried, it doesn't reflect changes that happen after the initial creation (for example, finalized fees or status updates). The Events endpoint logs all updates as they occur, giving you the most current view of activity when you query it.
Use cases
- Retrieving finalized fees. The platform_fee field in a donation will initially show 0 until Stripe finalizes the fee data. To get the updated fee values, use the Events endpoint to track the donation.success event, which confirms that the finalized fees have been updated.
- Monitoring donation status changes. Donations can move through multiple statuses — pending, success, failed, and more. Use the Events endpoint to track status changes. For example, a donation might be pending while awaiting payment processor confirmation and later transition to success or failed.
- Tracking refunds and disputes. If a donation is refunded or disputed, you'll receive corresponding events like donation.refunded, donation.success_dispute_created, or donation.success_dispute_won. This helps keep your records accurate without manually checking each donation.
- Handling recurring plan updates. Recurring donations generate events like recurring_plan.activated, recurring_plan.failed, or recurring_plan.canceled. Monitoring these events allows you to track subscription activities and take appropriate actions if a recurring payment fails or is canceled.
- Updating supporter information. When a supporter updates their information or requests personal data deletion, events like supporter.updated or supporter.personal_data_deleted are triggered. This is especially important for maintaining compliance with data protection regulations.
- Monitoring tribute activity. Use events like tribute.created or tribute.updated to keep track of tribute donations and ensure that tribute cards are sent as expected (tribute.shared).
Query parameters
Specifies whether the request is executed in live or test mode. Required for API keys created after 30th January 2026.
{
"created[gt]": "2025-01-01T12:30:00+02:00",
"created[gte]": "2025-01-01T12:30:00+02:00",
"created[lt]": "2025-01-01T12:30:00+02:00",
"created[lte]": "2025-01-01T12:30:00+02:00"
}A cursor for pagination. Returns records older than the specified object ID.
A cursor for pagination. Returns records newer than the specified object ID.
This parameter specifies the number of records to display per page, ranging from 1 to 100
An optional array of up to 10 strings containing specific event types. The response will include only events with a matching type. Passing more than 10 values results in an error. Not passing this parameter will return all event types.
Available event types include donation events (for example, donation.created), recurring plan events (for example, recurring_plan.activated), transaction attempt events (for example, transaction_attempt.success), benefit events (for example, donation_benefit.updated), tribute events (for example, tribute.created), and supporter events (for example, supporter.created).
[ "donation.created", "donation.success", "donation.failed" ]
Response
On success, the API returns the list of events. The response includes the event data array and a boolean indicating if more records are available.
Example response
{
"data": [
{
"account": {
"code": "Code-1",
"id": "AXXXXXXX",
"name": "Example Account"
},
"created_at": "2024-12-20T00:00:00.000Z",
"donation": "DXXXXXXX",
"id": "66911bb67616b5001045cccc",
"livemode": true,
"payments": [
{
"donation": "DXXXXXXX",
"recurring_plan": "RXXXXXXX"
}
],
"recurring_plan": "RXXXXXXX",
"supporter": "SWXXXXXX",
"type": "donation.created"
}
],
"has_more": true
}