Recurring Donation object contains information related to a Rallybound recurring donation plan.
Recurring Donation attributes are at times appended to the
Recurring_Donation, and at others to the
Donation handle. To determine the proper handle in a given environment, open the Placeholders popup to see how the
Recurring Donation attributes are referenced. For clarity, in this article we will use the
Recurring Donation object is available on the following Recurring Donation emails:
- Admin Recurring Donation Instance Failed Notification
- Recurring Donation Instance Failed
- Recurring Donation Plan Ended Notification
- Recurring Donation Plan Modified Notification
- Recurring Donation Plan Reactivated Notification
- Recurring Donation Plan Suspended Notification
Recurring Donation object has the following attributes:
Returns the donation amount for the recurring donation plan. Use a money filter to return the value in a monetary format:
Returns the status of the recurring plan. Available in the Recurring Instance Failed Notification auto responder. Use an if tag to inform donors of whether their plan will attempt another charge at the next interval.
If the plan is in "Retrying" status, the output will be:
If the plan is in "Failed" status, the output will be:
Returns the date on which the recurring plan was initially charged. The recurring charge date will follow this date (e.g., for monthly plans, the plan will process new donations on the same day of the month as the initial charge date). Use a date filter to return the value in a recognized format:
Returns the interval of the recurring plan. Interval can be day, week, month, quarter, or year. Use the adverb filter to modify the result to "daily", "weekly", "monthly", "quarterly", or "annually":
Returns a link to the recurring plan record in the donor portal, from which a user may manage their recurring plan. If the user has no account, this link will direct them to create an account before directing them to their donor portal.
Returns a link to a popup within the donor portal where a user can quickly upgrade their recurring plan. If the user has no account, this link will direct them to create an account before directing them to their donor portal.
The amount to upgrade can be pre-populated by appending the URL parameter "?amount=[amount]". Using the
assign variable tag, one can increase the donation amount relative to a donor's current recurring amount with liquid code. To increase by 10%, for example, use code that looks something like this:
Returns the amount of times the recurring plan was processed.
Returns the number of times the recurring plan will be charged in total. This only applies to plans that have a limit. Use an if tag to place this information only when applicable:
If the plan has a limit, the output will be:
If the plan has no limit, this sentence will be skipped.
Returns the amount of times the recurring plan has failed to process a charge. Available in the Recurring Instance Failed Notification auto responder.
Returns the three-letter currency key in which donations will be processed. For example: USD, CAD.