> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/Shopify/subscriptions-reference-app/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Build custom subscription solutions with the Shopify Subscriptions Reference App

<div className="mb-8 p-8 rounded-lg" style={{background: 'linear-gradient(135deg, #7ba44b 0%, #aecf7b 100%)'}}>
  <h1 className="text-4xl font-bold text-white mb-4">Shopify Subscriptions Reference App</h1>

  <p className="text-xl text-white opacity-90">
    A complete reference implementation for building subscription management applications on the Shopify platform using Remix
  </p>
</div>

## Overview

The Shopify Subscriptions Reference App is a production-ready example of how to build a subscriptions application with [Remix](https://remix.run/). It includes the core features of the [Shopify Subscription app](https://apps.shopify.com/shopify-subscriptions) and serves as a starting point for building custom subscription solutions.

<CardGroup cols={2}>
  <Card title="Quick Start" icon="rocket" href="/quickstart">
    Get up and running in minutes with our step-by-step guide
  </Card>

  <Card title="Core Concepts" icon="book" href="/concepts/subscription-contracts">
    Learn about subscription contracts, selling plans, and billing cycles
  </Card>

  <Card title="Extensions" icon="puzzle-piece" href="/extensions/overview">
    Explore the included Shopify UI extensions
  </Card>

  <Card title="API Reference" icon="code" href="/api/models/selling-plan">
    Dive into the complete API documentation
  </Card>
</CardGroup>

## Key Features

<AccordionGroup>
  <Accordion title="Subscription Contract Management">
    Comprehensive lifecycle management for subscription contracts including creation, pause, resume, and cancellation. Customers can manage their subscriptions through a self-service portal.
  </Accordion>

  <Accordion title="Flexible Selling Plans">
    Create and manage selling plans with customizable discount types (percentage or fixed amount) and delivery frequencies. Support for both prepaid and pay-as-you-go subscription models.
  </Accordion>

  <Accordion title="Automated Billing">
    Intelligent billing cycle scheduling with configurable timing and timezone support. Automatic billing attempt retries with dunning management for failed payments.
  </Accordion>

  <Accordion title="Shopify UI Extensions">
    Multiple UI extensions including customer account management pages, admin subscription actions, POS integration, and theme customizations.
  </Accordion>

  <Accordion title="Webhook Integration">
    Built-in webhook handlers for all subscription lifecycle events including contract creation, billing attempts, and plan updates.
  </Accordion>

  <Accordion title="Multi-language Support">
    Complete internationalization with i18next for supporting multiple languages and locales.
  </Accordion>
</AccordionGroup>

## Technology Stack

The reference app is built with modern web technologies:

* **[Remix](https://remix.run/)** - Full-stack web framework
* **[Shopify App Bridge](https://shopify.dev/docs/api/app-bridge)** - Embedded app integration
* **[Polaris](https://polaris.shopify.com/)** - Shopify's design system
* **[Prisma](https://www.prisma.io/)** - Database ORM
* **[GraphQL](https://graphql.org/)** - API communication with Shopify Admin API
* **[i18next](https://www.i18next.com/)** - Internationalization framework

## Use Cases

This reference app is designed for:

<CardGroup cols={2}>
  <Card title="Custom Subscription Solutions" icon="wrench">
    Build subscription features tailored to your specific business needs
  </Card>

  <Card title="Learning & Development" icon="graduation-cap">
    Learn best practices for building Shopify apps with subscriptions
  </Card>

  <Card title="Rapid Prototyping" icon="rocket">
    Quickly prototype and test subscription business models
  </Card>

  <Card title="Production Apps" icon="store">
    Use as a foundation for production subscription apps (must be substantively different for App Store)
  </Card>
</CardGroup>

## App Store Submission

<Warning>
  If you're building an application for the [Shopify App Store](https://apps.shopify.com/), your app must be [substantively different](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/subscriptions-app#uniqueness-from-other-apps) from this reference application to provide added value for merchants.
</Warning>

## Getting Help

<CardGroup cols={3}>
  <Card title="GitHub Repository" icon="github" href="https://github.com/Shopify/subscriptions-reference-app">
    View the source code and report issues
  </Card>

  <Card title="Shopify Dev Docs" icon="book-open" href="https://shopify.dev/docs/apps/build/purchase-options/subscriptions">
    Official Shopify subscriptions documentation
  </Card>

  <Card title="Shopify Community" icon="users" href="https://community.shopify.com/c/shopify-apps/bd-p/shopify-apps">
    Connect with other Shopify developers
  </Card>
</CardGroup>

## Next Steps

Ready to get started? Follow our [quickstart guide](/quickstart) to create your first subscription app, or dive into the [core concepts](/concepts/subscription-contracts) to understand how subscriptions work on Shopify.
