> ## Documentation Index
> Fetch the complete documentation index at: https://docs.reorderjs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Start

> Install the Reorder plugin into your Medusa project and start managing subscriptions in minutes.

## Prerequisites

Reorder is a plugin for an existing Medusa store. If you don't have one yet, [create a Medusa application](https://docs.medusajs.com/learn) first, then come back here.

Once you have a running Medusa store, make sure it meets the version requirements:

| Requirement        | Minimum | Recommended |
| ------------------ | ------- | ----------- |
| `@medusajs/medusa` | `2.3.0` | `>= 2.4.0`  |
| Node.js            | `20`    | Latest LTS  |

<Note>
  Reorder is **not compatible** with Medusa 1.x. It relies on modules, workflows, and Admin UI extensions introduced in Medusa 2.x.
</Note>

## Installation

<Steps>
  <Step title="Install the plugin">
    In your Medusa application, add `@reorderjs/reorder` using your preferred package manager.

    <CodeGroup>
      ```bash npm theme={null}
      npm install @reorderjs/reorder
      ```

      ```bash yarn theme={null}
      yarn add @reorderjs/reorder
      ```
    </CodeGroup>
  </Step>

  <Step title="Register the plugin">
    Open `medusa-config.ts` and add Reorder to the `plugins` array.

    ```ts medusa-config.ts theme={null}
    plugins: [
      // other plugins
      {
        resolve: "@reorderjs/reorder",
        options: {},
      },
    ]
    ```
  </Step>

  <Step title="Run migrations">
    Apply Reorder's database migrations from your Medusa application directory.

    <CodeGroup>
      ```bash npm theme={null}
      npx medusa db:migrate
      ```

      ```bash yarn theme={null}
      yarn medusa db:migrate
      ```
    </CodeGroup>
  </Step>

  <Step title="Start your store">
    Run your Medusa server. Reorder will register its modules, API routes, scheduled jobs, and Admin UI extensions on boot.

    <CodeGroup>
      ```bash npm theme={null}
      npm run dev
      ```

      ```bash yarn theme={null}
      yarn dev
      ```
    </CodeGroup>
  </Step>

  <Step title="Open the Admin">
    Navigate to your Medusa Admin dashboard. You will see a **Subscriptions** entry in the sidebar with access to Plans & Offers, Renewals, Dunning, Cancellations, Activity Log, and Analytics.
  </Step>
</Steps>

## What gets added to your store

Once the plugin is loaded, Medusa boots with the following additions from Reorder:

| Component               | What it provides                                                                                                                                                              |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Admin UI extensions** | Dedicated pages for Subscriptions, Plans & Offers, Renewals, Dunning, Cancellations, Activity Log, Analytics, Subscription Settings, plus an order-detail subscription widget |
| **Admin API routes**    | Protected REST endpoints under `/admin/` for all subscription operations, settings, and analytics queries                                                                     |
| **Store API routes**    | Customer-facing endpoints under `/store/` for subscription checkout and offer resolution                                                                                      |
| **Scheduled jobs**      | Renewal execution, dunning retry scheduling, and analytics roll-up jobs that run on configurable cadences                                                                     |

## Next steps

* [Core Concepts](/concepts/subscriptions) — understand the subscription lifecycle, plan model, and renewal flow
* [Plans & Offers](/admin/plans-offers) — create your first subscription plan and attach it to a product
* [Subscription Settings](/configuration/subscription-settings) — tune dunning intervals, trial defaults, and renewal behavior