WooCommerce IremboPay Gateway

A production-ready WordPress plugin that integrates IremboPay as a payment gateway for WooCommerce — including a built-in subscription engine for Tutor LMS courses and bundles. No WooCommerce Subscriptions plugin required.

---

✨ Features

• 💳 IremboPay inline checkout modal — no redirect to a third-party page
• 🔄 Built-in recurring payments — monthly, weekly, yearly billing without WooCommerce Subscriptions
• 📚 Tutor LMS integration — single courses, course bundles, enrollment & access control
• 📧 Renewal emails — automatic payment reminders sent to students
• ⏱️ Grace period — configurable days before access is suspended
• 🔔 Webhook handler — auto-completes orders and subscriptions on payment confirmation
• 🗂️ Admin subscription list — manage all subscriptions from WooCommerce menu
• 📝 WooCommerce HPOS compatible — works with High Performance Order Storage
• 🐞 Native WC Logger — all events logged under WooCommerce → Status → Logs

---

📋 Requirements

Requirement	Version
WordPress	5.8+
WooCommerce	6.0+
PHP	7.4+
Tutor LMS (optional)	Any

---

🚀 Installation

Option A — Upload via WordPress Admin

1. Download the latest .zip from Releases
2. Go to Plugins → Add New → Upload Plugin
3. Upload the zip and click Activate

Option B — Install via Git

cd wp-content/plugins
git clone https://github.com/YOUR_USERNAME/woocommerce-irembopay.git

Then activate from Plugins → Installed Plugins.

---

⚙️ Configuration

Go to WooCommerce → Settings → Payments → IremboPay:

Setting	Description
Secret Key	Your IremboPay private/secret key
Public Key	Your IremboPay public key (used in the JS modal)
Payment Account Identifier	e.g. TANGNEST_RWF
Default Product Code	IremboPay product code for line items
Test Mode	Toggle sandbox vs live

Webhook URL

Copy this URL into your IremboPay merchant dashboard:

https://yourstore.com/wp-json/irembopay/v1/webhook

---

🔄 Subscription Setup

1. Edit any WooCommerce product
2. Click the IremboPay Subscription tab
3. Check Enable Subscription
4. Set Billing Cycle (e.g. every 1 month)
5. Set Grace Period (days before access is suspended if unpaid)
6. Save — the product page will show "RWF 10,000 / every month"

Subscription Lifecycle

Customer buys course product
       ↓
Webhook PAID → subscription created in DB
       ↓
WP-Cron fires daily → finds subscriptions due for renewal
       ↓
Creates IremboPay invoice + sends "Pay Now" email to student
       ↓
Student pays → Webhook PAID → subscription extended
       ↓ OR
Student misses grace period → access suspended automatically

Admin Management

Go to WooCommerce → Subscriptions (IremboPay) to:

• View all subscriptions with status filters
• Pause / cancel / reactivate individual subscriptions
• Trigger a renewal invoice manually

---

📚 Tutor LMS Integration

When Tutor LMS is active the plugin automatically:

• Detects products linked to Tutor LMS courses and bundles
• Enrolls students on payment
• Revokes course access when a subscription expires or is cancelled
• Restores course access on reactivation or successful renewal
• Allows setting a per-course IremboPay product code on the course edit screen

---

📁 Plugin Structure

woocommerce-irembopay/
├── woocommerce-irembopay.php                      ← Main entry point
├── includes/
│   ├── class-irembopay-logger.php                 ← WC logger wrapper
│   ├── class-irembopay-api.php                    ← IremboPay HTTP client
│   ├── class-irembopay-webhook.php                ← REST webhook handler
│   ├── class-wc-gateway-irembopay.php             ← WC payment gateway
│   ├── class-irembopay-subscription-db.php        ← Custom DB table & CRUD
│   ├── class-irembopay-subscription-manager.php   ← Subscription business logic
│   ├── class-irembopay-subscription-cron.php      ← WP-Cron jobs
│   ├── class-irembopay-subscription-product.php   ← Product settings UI
│   ├── class-irembopay-tutor-integration.php      ← Tutor LMS bridge
│   └── admin/
│       └── class-irembopay-subscriptions-admin.php ← Admin list page
└── templates/
    └── payment-page.php                           ← Inline payment page

---

🔗 IremboPay API Reference

• Dashboard: https://dashboard.irembopay.com
• API Docs: https://api.irembopay.com/docs

---

📝 Changelog

v2.8.8

• Fix: Nullable return type on tutor_single_course_price(); price display shows billing interval only

v2.8.7

• Fix: Price display now shows only billing interval (e.g. "26,250 Rwf / month") — total_payments is backend-only and never shown to customers

v2.8.6

• Improved: Billing period suffix on single course page now matches price font size and color

v2.8.5

• Fix: Single course page now shows billing period (e.g. "/ 6 months") below the price using tutor_course_details_wc_add_to_cart_price filter

v2.8.4

• Fix: Single course page now shows "100 Rwf / 6 months" via get_tutor_course_price filter
• Fix: Price suffix no longer duplicated when WooCommerce filter fires twice

v2.8.3

• Fix: Price suffix "/6 months" no longer duplicated when WooCommerce filter fires twice
• Fix: Single course page now shows correct price with billing period via tutor_course_price filter

v2.8.2

• Fix: Course listing and single page price now shows "100 Rwf / 6 months" for installment products — clean public display without internal payment count details
• Removed: "× N payments" text from public price display (admin-only info, shown in subscriptions table)

v2.8.1

• Config: Cron switched back to production timing — renewals run daily at midnight, expiry checks run twice daily

v2.8.0

• New: Total Payments / Installment system — set how many payments a student makes before they own the course permanently
• New: "Total Payments" field on product IremboPay Subscription tab (0 = renews forever)
• New: After final payment, subscription status changes to "owned" — no more renewals, permanent course access
• New: Payments progress shown in admin subscription table (e.g. "2 / 3 payments")
• New: "Owned" status shown in purple in admin table
• New: Price display on course page shows payment breakdown (e.g. "100 Rwf / 1 Month × 6 payments")
• DB: Added total_payments and payments_made columns with auto-migration

v2.7.3

• Fix: Tutor LMS product link now detected via both _tutor_course_product_id (UI key) and _tutor_product (legacy key) — courses linked via the Tutor LMS UI now automatically revoke/restore access without any manual setup

v2.7.2

• Fix: Course access revocation now works correctly — replaced $wpdb->update() with $wpdb->query() + prepare() for reliable multi-condition WHERE clause
• Fix: Email brand color updated to #132241 across renewal and expiry email templates (header, button, accent)

v2.7.1

• Fix: Bulk actions now work correctly — WP_List_Table must post back to the same page, not admin-post.php
• Fix: Nonce key corrected to 'bulk-subscriptions' (WP convention: bulk- + plural)
• Fix: Bulk action processed in load-{hook} before render, then redirects cleanly

v2.7.0

• New: Subscriptions admin rebuilt using WordPress WP_List_Table
• New: Bulk actions — select multiple subscriptions and Pause, Cancel, or Delete in one click
• New: Search box — search by student name, email, parent name, parent phone, or order number
• New: Per-page selector — choose 25, 50, or 100 rows per page via Screen Options
• New: Proper WordPress pagination with prev/next
• Removed: ID column
• Improved: Sortable columns (Status, Amount, Next Renewal)

v2.6.9

• Improved: Parent WhatsApp column now shows ⚠️ warning + Edit Profile link when no parent phone is on file
• Improved: WhatsApp send button styled as a green pill badge
• Improved: Actions column buttons now stacked vertically with icons, more readable
• Improved: Order link moved below action buttons, smaller and unobtrusive

v2.6.8

• Fix: WhatsApp link now uses esc_attr() instead of esc_url() — esc_url() was uppercasing %0a to %0A which WhatsApp Web ignores, causing line breaks to collapse

v2.6.7

• Fix: WhatsApp message line breaks now render correctly on WhatsApp Web desktop
• Root cause: rawurlencode() produces uppercase %0A which WhatsApp Web ignores; switching to urlencode() per line joined with lowercase %0a fixes it

v2.6.6

• Fix: WhatsApp links now use web.whatsapp.com instead of wa.me — line breaks render correctly in the desktop browser input box before sending

v2.6.5

• Fix: WhatsApp message in admin now uses correct wording and parent name in all cases (active subscription, pending renewal, expired)
• Fix: HTML entity decode applied correctly in admin WhatsApp field — course name now shows clean dashes instead of –

v2.6.4

• Fix: WhatsApp messages now addressed to parent by name (from parent_name user meta) instead of student
• Fix: Course name HTML entities (e.g. –) now decoded to clean characters in WhatsApp messages
• Fix: Student referenced by first name only in message body
• Fix: All three WhatsApp message templates (renewal, expiry, admin manual) updated to approved wording with amount, grace period days, and direct Pay Now link

v2.6.3

• Fix: Correct user meta key for parent phone number (phone_number not parent_phone) — WhatsApp column now populates correctly from the Parent/Guardian profile field

v2.6.2

• New: "Minute(s)" billing period added to product subscription settings for testing renewal and expiry flows quickly (e.g. set "Bill every 10 Minutes" on a test product)

v2.6.1

• Fix: Parent WhatsApp number now read automatically from the student's user profile (Parent/Guardian Phone field) — no manual entry needed
• Fix: Renewal and expiry notification emails now sent to parent email address from user profile, not student email
• Fix: WhatsApp send link now always visible in admin whenever a parent phone number exists on the profile — not only when an invoice is pending
• Removed: Manual WhatsApp input field from subscription admin table (number comes from user profile automatically)

v2.6.0

• New: Expiry email sent to student when subscription expires — includes a "Restore Access — Pay Now" button with a fresh invoice link
• New: Parent WhatsApp contact field on every subscription row in the admin table
• New: WhatsApp message link auto-generated on renewal and expiry — click to open WhatsApp with message pre-written, then send manually
• New: 5-minute cron interval registered for testing renewal and expiry flows quickly
• Fix: Subscription expiry was previously silent — no student or parent notification was sent
• DB: parent_whatsapp column added to wp_irembopay_subscriptions table with auto-migration for existing installs

v2.5.1

• Fix: Regular price field no longer hidden for subscription products
• Fix: Subscription price now displays correctly on course listing

v2.5.0

• Removed: Subscription plan system (plans, plan selector, cart injection)
• Cleaned: Plugin returns to simple one-time and recurring payment flow
• Kept: Webhook handler, subscription renewal, cron jobs, admin UI

v2.4.7

• Fix: Plan selector now inside WooCommerce form — plan price correctly passed to checkout
• Fix: Removed duplicate Subscribe button — WooCommerce button used directly
• Fix: Subscribe redirects directly to checkout
• Fix: Checkout now shows correct plan price instead of 0 Rwf

v2.4.6

• Fix: Radio buttons restored on plan selector
• Fix: Subscribe button now shows below plan options
• Fix: Redirects to checkout instead of showing View Cart

v2.4.5

• Fix: Plan selector JavaScript no longer renders as visible text on the page
• Fix: Variable conflict error resolved by moving JS to wp_footer

v2.4.4

• New: Plan selector with radio buttons shown on course card and product page
• New: Selected plan highlighted with blue border
• New: First plan pre-selected by default

v2.4.3

• Fix: Subscription products now show "Subscribe" button instead of "Read more"
• Fix: All plans now displayed on course card and product page

v2.4.2

• Fix: Database tables now auto-created on plugin load, not just on activation
• Fix: Prevents silent save failures when plugin is deployed by copying files

v2.4.1

• Fix: Subscription plan data now saves correctly
• Fix: Regular price and Sale price fields hidden when subscription is enabled

v2.4.0

• New: Subscription plan system — each product supports up to 3 configurable plans
• New: Each plan has its own price, billing interval, total duration and grace period
• New: Students pick a plan at checkout; auto-billing runs until course is owned
• New: Course ownership granted automatically after all payments complete
• Removed: Installment payment system replaced by subscription plans

v2.3.3

• Fix: Installment checkboxes now display as pill buttons, fully visible and properly spaced

v2.3.2

• Fix: Installment checkboxes are now much larger and clearly readable with proper spacing

v2.3.1

• Fix: Added spacing between "Every" label and billing cycle dropdown
• Fix: Installment checkboxes are now larger and have proper spacing between them