Neon One Help Center home page
Neon One Help Center home page
support

Articles in this section

Recurring Donation Object

Last updated

The Recurring Donation object contains information related to a Neon Fundraise recurring donation plan. 

Availability: 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 handle.

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

Attributes: The Recurring Donation object has the following attributes:

  • Recurring_Donation.Amount
  • Recurring_Donation.Status
  • Recurring_Donation.Start_Date
  • Recurring_Donation.Recurring_Period

  • Recurring_Donation.Recurring_Manage_URL

  • Recurring_Donation.Recurring_Upgrade_URL
  • Recurring_Donation.Charged_Count

  • Recurring_Donation.Total_Charge_Count

  • Recurring_Donation.Failed_Charge_Count
  • Recurring_Donation.Currency_Key

Recurring_Donation.Amount

Returns the donation amount for the recurring donation plan. Use a moneyfilter to return the value in a monetary format:

Input

{{ Recurring_Donation.Amount | money }}

Output

$36

Recurring_Donation.Status

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.

Input

Your recurring plan failed to charge.
{% if Recurring_Donation.Status == "Retrying" %}
We will attempt to charge your card again at your next scheduled interval.
{% elsif Recurring_Donation.Status == "Failed" %}
This plan will no longer attempt to charge your card again. Please contact us to get your recurring plan back on track.
{% endif %}

If the plan is in "Retrying" status, the output will be:

Output

Your recurring plan failed to charge. We will attempt to charge your card again at your next scheduled interval.

If the plan is in "Failed" status, the output will be:

Output

Your recurring plan failed to charge. This plan will no longer attempt to charge your card again. Please contact us to get your recurring plan back on track.

Recurring_Donation.Start_Date

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 datefilter to return the value in a recognized format:

Input

{{ Recurring_Donation.Start_Date | date: "%B %d, %Y, %I:%M %p" }}

Output

January 1, 2019, 08:16 PM

Recurring_Donation.Recurring_Period

Returns the interval of the recurring plan. Interval can be day, week, month, quarter, or year. Use the adverbfilter to modify the result to "daily", "weekly", "monthly", "quarterly", or "annually":

Input

Your card will be charged {{ Recurring_Donation.Recurring_Period | adverb }}.

Output

Your card will be charged monthly.

Recurring_Donation.Recurring_Manage_URL

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.

Recurring_Donation.Recurring_Upgrade_URL

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 assignvariable 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:

{% assign upgrade_amount = Donation.Amount | times: .1 %}
{{Recurring_Donation.Recurring_Upgrade_URL}}?amount={{upgrade_amount}}

Recurring_Donation.Charged_Count

Returns the amount of times the recurring plan was processed.

Recurring_Donation.Total_Charge_Count

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:

Input

{% if Recurring_Donation.Total_Charge_Count > 0 %}
This plan will stop processing donations after {{ Recurring_Donation.Total_Charge_Count }} charges.
{% endif %}

If the plan has a limit, the output will be:

Output

This plan will stop processing donations after 10 charges.

If the plan has no limit, this sentence will be skipped.

Recurring_Donation.Failed_Charged_Count

Returns the amount of times the recurring plan has failed to process a charge. Available in the Recurring Instance Failed Notification auto responder.

Recurring_Donation.Currency_Key

Returns the three-letter currency key in which donations will be processed. For example: USD, CAD.