Recurring
The Recurring entity identifies the schedule, amount, and frequency for a recurring donation.
Individual donations linked to a recurring schedule reference this entity through the parentKey field on the Donation entity.
| Field | Type | Description |
|---|---|---|
key |
String | Unique key identifying the recurring donation. |
status |
String | Current status of the recurring donation (e.g., "active", "paused", "cancelled"). |
statusReason |
String | Reason for the current status, if applicable. |
amount |
Number | Amount to be donated on each recurrence. |
currency |
String | Currency code for the recurring donation. |
feePlatform |
Number | Total platform fee for each recurrence. |
feePlatformPublic |
Number | Publicly visible portion of the platform fee. |
feePlatformPrivate |
Number | Privately tracked portion of the platform fee. |
startDate |
DateTime | Date when the recurring donation starts. |
endDate |
DateTime | Date when the recurring donation ends. |
nextPaymentDate |
DateTime | Date of the next scheduled payment. |
frequency |
String | Frequency type for the recurring donation (e.g., "monthly", "yearly"). |
frequencyUnit |
Number | Number of units between each recurrence. |
frequencyInterval |
String | Interval unit for the recurrence (e.g., "week", "month"). |
day |
Number | Specific day for the recurrence, if applicable. |
marketing |
Marketing | Marketing metadata associated with the recurring donation. |
custom |
Object | Custom metadata for additional configuration. |