Once you have created your new Upgrade Widget, you'll need to embed it on your website in order to create links for your donors to go to upgrade their recurring plans.
Embedding the Widget
Step 1] Within the Widgets section of the Organization tab there is a section for the Payment Schedule Upgrade Widget. Next to your widget that you created, there will be brackets underneath "Snippet" for you to click to get your embeddable code:
Step 2] Copy the code that appears:
Step 3] Embed the code into the html of your website where you want the widget to appear.
Step 4] In its default state without a specific payment plan referenced in the webpage URL, the Upgrade Widget will display like this:
NOTE: Any time the widget cannot find a recurring plan to upgrade, the above error message will be displayed.
Utilizing the widget
In order to utilize the Recurring Upgrade widget, you need to create custom URLs to send to your donors. The URLs will be specific to each donor's payment plan.
The appended URL needs to include 3 elements:
The URL of the page where your Recurring Upgrade widget is embedded
The 'Secure Access Token' of the donor's individual payment plan
The desired dollar amount to increment the plan
In order to obtain individual 'Secure Access Tokens' for each your recurring donors, you will need to use a Payment Schedules Report. You will need to edit your Payment Schedules Report to include the 'Secure Access Token' column:
First, on your Payment Schedules Report, click on the "+ ADD COLUMN" button in the 'Format As...' section:
...Next, within the Schedule Details category, select the 'Secure Access Token' column:
... Finally, save the column to your report and then save your report!
Once you have the 'Secure Access Tokens' for your recurring donors' plans, you are ready to create the unique URLs to email out to your donor-base.
The URL must include the Secure Access Token &scheduleToken= AND the Change Value &amountChange= parameters. The amountChange is a positive integer of the amount to increase the payment schedule by, expressed in cents (i.e., $5.00 would be a value of 500). If either or both parameters are missing, or if the amountChange value cannot be interpreted as a positive integer, the widget will display a generic error message.
The URL you'll send out to donors will be similar to:
https://www.example.org/upgradeplan/?scheduleToken=46OSR69N5OUVGKXGDMGSWQYYO3UAX3&amountChange=500
In the example above, the payment schedule that corresponds to the access token will be asked to upgrade the plan by $5.00.
When URL is appended with the &scheduleToken= and &amountChange= , the widget will look like this:
It gives the donor information about the upgrade, and the option to either upgrade their plan or cancel the upgrade.
If the donor chooses to cancel the upgrade, they will see the below message:
If the donor chooses to upgrade the plan, they will see the below message:
Along with the on-screen confirmation, the donor will receive an email detailing the change that was made to their plan:
If you have any questions about implementing the Payment Schedules Upgrade Widget on your website or its functionality, please contact our team at enterprise-support@givegab.com.