PayPal Checkout Migration Guide

From WHMCS Documentation

PayPal Checkout is the latest and recommended PayPal integration to use for accepting payments by PayPal.

If you have used the previous PayPal module for automated recurring PayPal subscriptions, we recommend migrating to the newer PayPal Checkout module. If you have not used the previous module, you do not need to perform these migration steps and can go immediately to the new PayPal Checkout module.

To learn more about PayPal Checkout and the integration features, see PayPal Checkout.

Step 1: Activate the PayPal Checkout module

To activate the PayPal Checkout module:

  1. Find the PayPal Checkout module in the list of available payment gateways:
    • In WHMCS 8.6 and later, go to Configuration () > Apps & Integrations.
    • In WHMCS 8.0 through 8.5, go to Configuration () > System Settings > Payment Gateways.
    • Prior to WHMCS 8.0, go to Setup > Payment Gateways.
  2. Click the PayPal banner or, in WHMCS 8.5 and later, click Activate & Configure.
  3. Follow the instructions to sign in to your PayPal account in order to link it with your WHMCS installation.

Step 2: Hide the PayPal Basic module

The PayPal Checkout module is not a direct replacement for the previous PayPal module.

If you set up PayPal subscriptions via the previous PayPal integration (PayPal Basic) or via a custom or third-party PayPal integration, do not deactivate the PayPal Basic module. The PayPal Basic module must be kept active for WHMCS to continue recognizing and applying recurring payments.
Uncheck Show on Order Form
  1. Navigate to Configuration () > System Settings > Payment Gateways or, prior to WHMCS 8.0, Setup > Payment Gateways.
  2. Locate the PayPal Basic module.
  3. Uncheck the Show on Order Form checkbox.
  4. Click Save Changes.

This will stop the PayPal Basic module from showing in the list of available payment methods both during checkout as well as via the Payment Method selection menu on invoices (if you have enabled it).

Step 3: Migrating existing products/services

In order to have existing products and services benefit from the new features and functionality of the PayPal Checkout module, it is necessary to change their default payment method to the new module.

This can be done on an individual basis, or can be done in bulk by executing the following queries against your WHMCS database:

UPDATE tblhosting SET paymentmethod='paypalcheckout' WHERE paymentmethod='paypal';
UPDATE tblhostingaddons SET paymentmethod='paypalcheckout' WHERE paymentmethod='paypal';
UPDATE tbldomains SET paymentmethod='paypalcheckout' WHERE paymentmethod='paypal';
UPDATE tblinvoices SET paymentmethod='paypalcheckout' WHERE paymentmethod='paypal' AND status IN ('Draft','Unpaid');

This will update all products, services, addons, domains, and draft or unpaid invoices to use the new PayPal Checkout integration.

The PayPal Basic module will remain active to receive and handle IPN notification of payments appropriately.