Skip to content
Documentation

Installation and requirements

What your server and store need before you start, how to get the plugin installed and activated, and which permissions its Paddle API key needs.

Requirements

Make sure your environment meets these before installing.

  • PHP8.3+
  • WordPress7.0.3+
  • WooCommerce4.0+
  • MySQL8.x
  • PaddleBilling account (sandbox or production)
  • SSLHTTPS required

HPOS (High-Performance Order Storage) compatible. PSR-4 autoloading via Composer.

Installation

  1. Purchase the plugin and download the ZIP from portal.w4dev.com → My account → Downloads (also linked in your purchase email). Your license key is under My account → Licenses.
  2. In WordPress Admin, go to Plugins → Add New → Upload Plugin, choose the ZIP, and click install.
  3. Activate PimiPay Paddle for WooCommerce.
  4. Go to WooCommerce → PimiPay License, paste the license key from your purchase email, and click Save License to turn on automatic updates.
  5. Create a Paddle API key with the permissions below.
  6. Go to WooCommerce → Settings → Payments → Paddle and configure credentials.

Paddle API key permissions

In Paddle, go to Settings → Authentication → API keys and click New API key. Create one in your sandbox account for Staging and one in your live account for Production. Under Permissions, the form lists what the key can reach in alphabetical order, each with a Read and a Write box. Tick these, in the same order, and leave everything else off:

  • Adjustments Write Refunds
  • Customer portal sessions Write Manage Billing in the customer’s My Account
  • Notification settings Write Registering the webhook
  • Notifications Write The webhook delivery log and resending a delivery
  • Prices Write Sync with Paddle
  • Products Write Sync with Paddle
  • Subscriptions Read Subscriptions, only if you sell them
  • Transactions Write Order total checkout, payment checks and invoices

Paddle API keys expire and cannot be renewed, so note the expiry date: the plugin emails you before it runs out.