SubscriptionFlow PayPal Gateway

What this does

This is a self‑contained PayPal payment method built for subscriptions. At checkout it creates a PayPal order that also vaults the buyer’s PayPal account; on return, the payment is captured and a reusable token is stored. At renewal time, SubscriptionFlow charges that token off‑session — no customer action required.

Why it exists: standard PayPal buttons can’t charge a customer again later. This gateway can, which is exactly what recurring subscriptions need.

Benefits

• Automatic PayPal renewals.
• A familiar “Pay with PayPal” experience at checkout.
• Server‑side safety net so approved payments are never lost.
• Full and partial refunds from WooCommerce.

---

What you need first

1. A PayPal Business account.
2. A PayPal REST app (Client ID + Client Secret) created at developer.paypal.com → Apps & Credentials.
3. Vaulting / “Save PayPal” enabled on the app (required so renewals can charge later).
4. An active SubscriptionFlow Pro license.

---

How to set it up

Step 1 — Open the gateway settings

Go to WooCommerce → Settings → Payments and open SubscriptionFlow PayPal Payment.

Step 2 — Enter your API credentials

• Paste your Client ID and Client Secret.
• Set a Title and Description (what customers see at checkout).
• Optionally set an Invoice prefix (keep it unique if one PayPal account serves multiple stores).

Step 3 — Choose the mode

Turn on PayPal sandbox while testing (use sandbox credentials), then switch it off and use live credentials when you go live.

Step 4 — Enable and save

Tick Enable, then Save changes.

Step 5 — Add the webhook (recommended)

In your PayPal app, add a webhook for the events “Checkout order approved” and “Payment capture completed”, pointing to the URL shown in the gateway settings (it looks like https://your-site.com/wc-api/subflow_paypal). Then paste the Webhook ID back into the gateway settings.

This lets a payment complete even if the customer closes the tab before returning to your site.

---

How a payment flows

1. Checkout: the customer chooses PayPal and approves the payment on PayPal.
2. Return & capture: back on your site, the order is captured and a reusable vault token is stored — but only if the amount matches the order (a built‑in safety check).
3. Renewal: when the subscription is due, SubscriptionFlow charges the stored token off‑session and extends the subscription.
4. Webhook safety net: if the buyer doesn’t return, the webhook completes the order server‑side.

---

Refunds

Because the gateway supports refunds, you can issue full or partial refunds directly from the WooCommerce order screen, and they’re processed through PayPal.

---

Tips & Best Practices

• Enable Vaulting on your PayPal app — without it, renewals can’t be charged automatically.

• Always test in sandbox first. Place a sandbox order, confirm capture, and confirm a renewal charge before going live.

• Set the webhook + Webhook ID. It’s the safety net that captures payments even if a customer abandons the return step.

• Use a unique invoice prefix if the same PayPal account is shared across multiple stores.

• Keep credentials for the matching mode. Sandbox credentials only work in sandbox; live credentials only in live.

---

Frequently Asked Questions