Skip to main content
Reorder is installed as a standard Medusa plugin. Adding it to your project registers Admin UI extensions, Admin and Store API routes, and the scheduled jobs that power renewals, dunning, and analytics — no separate server required.

​
Install the package

Add @reorderjs/reorder to your Medusa project using npm or yarn. 
npm install @reorderjs/reorder

​
Add the plugin to medusa-config.ts

Open your medusa-config.ts file and add Reorder to the plugins array.
medusa-config.ts
plugins: [
  // other plugins
  {
    resolve: "@reorderjs/reorder",
    options: {},
  },
]
The options object is required but empty for the current release. No configuration values are needed to get the plugin running.

​
Start Medusa

Run your normal Medusa startup command. Reorder registers all of its components on boot. 
yarn dev

​
Local development with a checked-out Reorder repo

If you are developing Reorder locally and want a Medusa backend to use your local checkout instead of the published package, point the backend dependency to the local filesystem copy.
package.json
{
  "dependencies": {
    "@reorderjs/reorder": "file:../reorder"
  }
}
After adding or updating that dependency, run: 
yarn install

​
Refreshing the local plugin version in a Medusa backend

When you change code in your local reorder repository, use this sequence so the Medusa backend picks up the newest build and migrations:
  1. In the reorder repository, run yarn medusa plugin:publish
  2. In the Medusa backend, run yarn medusa db:migrate
  3. In the Medusa backend, run yarn install
Do not assume your Medusa backend is using the newest local plugin code until that sequence has completed.

​
What gets added to your store

Once the plugin is loaded, Medusa boots with the following additions from Reorder:
ComponentWhat it provides
Admin UI routesDedicated pages for Subscriptions, Plans & Offers, Renewals, Dunning, Cancellations, Activity Log, Analytics, and Subscription Settings — accessible from the Medusa Admin sidebar
Admin API routesProtected REST endpoints under /admin/ for all subscription operations, settings, and analytics queries
Store API routesCustomer-facing endpoints under /store/ for subscription checkout and offer resolution
Scheduled jobsRenewal execution, dunning retry scheduling, and analytics roll-up jobs that run on configurable cadences
After starting Medusa, open the Admin dashboard and look for the Subscriptions entry in the sidebar to confirm the plugin loaded correctly.

​
Next steps

  • Subscription settings — configure global defaults for trials, dunning, renewals, and cancellations
  • Plans & Offers — create your first subscription plan and attach it to a product
  • Requirements — verify Node.js and Medusa version compatibility before installing