Recurring Payments - Upgrading to 2.4 from Earlier Versions
Recurring Payments 2.4 is such a major update from previous versions that there are some important procedures that need to be followed in order to ensure the update goes smoothly. This document will walk you through the update process to 2.4 from earlier versions of the Recurring Payments plugin for Easy Digital Downloads.
There are several parts to the upgrade process so each is covered separately below.
Step 1: Installing the Update
Due to the significance and size of the update, installing version 2.4 of Recurring Payments must be done manually and cannot be done through the standard 1-click update process in WordPress.
The Recurring Payments 2.4 update is available to all active license holders from your account page. If your license key has expired, you may also renew it from your account page. You must have an active license key in order to download Recurring Payments version 2.4 (or any other version).
Once you have downloaded the .zip file for the update, you may install it on your WordPress website through the Plugins > Add New page. If you already have a previous version of Recurring Payments installed, see the bottom of this document for instructions on how to update an existing plugin from a .zip file.
As soon as version 2.4 is installed, if it is not already activated, click Activate from the Plugins page then proceed on with step 2.
Step 2: Install Other Necessary Plugin Updates
Recurring Payments 2.4 also depends on several other recently released updates to Easy Digital Downloads core and extensions. Please ensure you update to the necessary version of Easy Digital Downloads and, if you use any of them, the plugins below:
- Easy Digital Downloads version 2.5.7 or later
- Easy Digital Downloads - Stripe Payment Gateway 2.4 or later
- Easy Digital Downloads - 2Checkout Payment Gateway 1.3.3 or later
- Easy Digital Downloads - Authorize.net Payment Gateway 1.1 or later
- Easy Digital Downloads - PayPal Website Payments Pro and PayPal Express Gateway 1.4 or later
- Easy Digital Downloads - Auto Register 1.3.3 or later
- Easy Digital Downloads - Content Restriction 2.1.3 or later
- Easy Digital Downloads - Software Licensing 3.4.6 or later
If you are running a version earlier than specified here for any of these plugins, you must update in order to properly utilize the integration with Recurring Payments. If you need to update an extension and are unsure how, see this document.
Step 3: Ensure Your Stripe API Keys are Entered
Ignore this step if you do not use the Stripe.com payment gateway.
In order to properly upgrade your database for version 2.4, there are a number of API calls to Stripe.com that must be placed. Please ensure that your API keys for both TEST and LIVE mode are entered in Downloads > Settings > Payment Gateways > Stripe to ensure that the Recurring Payments plugin can properly query Stripe.com
Step 4: Run the Database Upgrade Routine
Part of the Recurring Payments 2.4 update includes a completely new database table for storing subscription records. If you have been selling subscriptions prior to installing version 2.4, you must run the upgrade routine.
Depending on the number of subscriptions in your system, this could take a very long time to complete. No worries though, you can leave it running while your store is fully operational. Simply start the upgrade routine and leave it open in a window or tab.
Note: if you close the window, the upgrade routine will stop and it will need to be restarted from where it left off. It is recommended that you run the entire upgrade routine at one time to ensure the best data integrity.
Step 5: Update Your Shortcodes
With Recurring Payments 2.4 is a new, comprehensive shortcode for providing customers with access to their subscription information, including options to cancel a subscription and update their payment method.
Due to the new [edd_subscriptions] shortcode, the old shortcodes for [edd_recurring_cancel] and [edd_recurring_update] have been removed. Please remove them from your site and use just [edd_subscriptions].
Step 6: Update Your Custom Code
If you have added any custom code to your themes or plugins that relies on Recurring Payments, you may need to update it for changes in version 2.4. Please see our comprehensive blog post about all changes to determine if you need to make any adjustments.
Step 7: Configure New Settings
Recurring Payments 2.4 introduces a large number of new settings that need to be configured. These settings include new email options, discount settings, access controls, and more. See our complete documentation for getting started with setup.
Step 8: Test
As with any major update, one of the single most important things you can do after installing the update is to test that everything is working as expected. After updating to Recurring Payments 2.4, please test the entire site to ensure there are no issues. We recommend at minimum testing the following:
- Test purchasing a new subscription with each gateway you accept payments through
- Test purchasing a non-subscription
- Test cancelling a subscription
- Test that customers can log into their account and view subscriptions
- Test that customers can properly access their purchased items
- Test that discount codes work as expected
- Test that renewal rates are set as expected
- Test that cancellation emails send properly
Recurring Payments 2.4 requires PHP version 5.3.3 or later. Please ensure you are running at least 5.3.3 or later before installing the update. If you are unsure how to find this information, contact your hosting company. They can provide it for you.