README

Reusable WP REST API proxy routes for the Freemius WordPress SDK.

Provides three ready-made route handlers — Account, Affiliate, and Pricing — that any WordPress plugin using Freemius can register by implementing a single interface.

Requirements

• PHP 7.4+
• WordPress 6.0+
• Freemius WordPress SDK (bundled in the consuming plugin)

Installation

composer require thewpsquad/freemius-wp-rest

Usage

1. Implement FreemiusProvider

use TheWPSquad\FreemiusRest\Contracts\FreemiusProvider;
use Freemius;
use Throwable;

class MyPluginFreemiusProvider implements FreemiusProvider {

    public function get_fs(): Freemius        { return my_fs(); }
    public function get_plugin_slug(): string { return 'my-plugin'; }
    public function get_rest_version(): string { return 'v2'; }
    public function get_capability(): string  { return 'manage_options'; }
    public function get_text_domain(): string { return 'my-plugin'; }
    public function get_cache_prefix(): string { return 'my_plugin_'; }

    public function log_error( Throwable $e, string $context ): void {
        // forward to your plugin's error logger
        error_log( "[{$context}] " . $e->getMessage() );
    }
}

2. Register routes inside rest_api_init

add_action( 'rest_api_init', function () {
    $provider = new MyPluginFreemiusProvider();

    ( new \TheWPSquad\FreemiusRest\Routes\Account( $provider ) )->register();
    ( new \TheWPSquad\FreemiusRest\Routes\Affiliate( $provider ) )->register();
    ( new \TheWPSquad\FreemiusRest\Routes\Pricing( $provider ) )->register();
} );

Routes register under {plugin_slug}/{rest_version} — e.g. my-plugin/v2.

Endpoints

Account — GET /my-plugin/v2/account

Returns merged user + site + plan + license + boolean flags.

Affiliate — GET /my-plugin/v2/affiliate

Cached 12 h. Clears on successful application.

Payments — GET /my-plugin/v2/payments

Subscriptions — GET /my-plugin/v2/subscriptions

Connect — GET /my-plugin/v2/connect

Addons — GET /my-plugin/v2/addons

Trial — GET /my-plugin/v2/trial

Notices — GET /my-plugin/v2/notices

Notices are computed from live SDK state (not stored). Dismissed per-user via WordPress user meta.

Notice IDs: not_connected, no_license, license_expiring, license_expired, trial_ending, pending_activation

Pricing — GET /my-plugin/v2/pricing

No cache — always returns live prices.

FreemiusProvider interface

License

GPL-3.0-only — see LICENSE.