SubSuite Documentation

Everything you need to build and manage subscription commerce on Shopify.

Getting Started

SubFlow — Subscription Engine

The foundation of SubSuite. Manage selling plans, subscription contracts, and the customer portal.

Overview

SubFlow is the core subscription management module included with every SubSuite plan. It handles the full lifecycle of subscription commerce: creating and managing selling plans in Shopify, tracking subscription contracts, and providing a customer-facing portal for self-service management.

As the foundation of SubSuite, SubFlow powers all subscription functionality across the platform. Whether you're running a basic subscription offering or a complex multi-plan commerce strategy, SubFlow provides the infrastructure to manage every aspect of the customer subscription journey.

Selling Plans

Create flexible subscription plans with comprehensive customization options. Define the cadence and pricing structure that matches your business model.

Subscription Contracts

Every subscription in SubFlow is represented as a contract that tracks the complete lifecycle of the customer relationship. Contracts are created automatically when customers subscribe and provide a complete audit trail of all changes.

Contract Status Tracking

Event Logging & Audit Trail

Every lifecycle change is logged automatically for a complete audit trail. You can track when a subscription was created, activated, paused, resumed, cancelled, or expired.

Contract Data

Contracts automatically store customer details, order information, and subscription parameters locally for fast access and reporting. This includes:

• Customer name, email, and contact details
• Billing and shipping addresses
• Original order and subscription parameters
• Current status and next billing date
• Payment method and billing history
• Custom metadata and tags

Customer Portal

SubFlow includes a REST API that powers a full-featured customer portal. Allow customers to self-manage their subscriptions directly from your storefront or a dedicated portal.

The Portal API integrates seamlessly with your Shopify theme or headless storefront. Customers can:

• Pause their subscription temporarily
• Resume a paused subscription
• Cancel at any time
• Skip the next billing cycle
• Swap to a different product
• Change Frequency of deliveries
• View History of all transactions

Webhook Integration

SubFlow uses Shopify webhooks to synchronize subscription data in real-time. This ensures your subscription data is always up-to-date and consistent with Shopify.

SubPulse — Analytics & Insights

Track MRR, churn, LTV, and subscriber trends with real-time analytics dashboards.

Overview

SubPulse gives you deep visibility into your subscription business performance. Track key metrics in real-time, visualize revenue trends, analyze subscriber cohorts, and forecast future growth — all from a single dashboard.

Key Metrics

Dashboards & Charts

• Revenue Timeline: Daily MRR charted over 30/60/90 day windows using interactive line charts.
• Subscriber Growth: Area chart showing daily active subscriber count trends.
• Revenue Breakdown: Revenue split by product and by selling plan.
• Revenue Forecast: Linear projection of MRR forward 6 months based on historical growth rate.

Cohort Retention Analysis

• Cohort Grouping: Subscribers grouped by month of first subscription.
• Retention Tracking: Up to 12-month retention tracked per cohort.
• Visualization: Retention rates displayed as percentages in a heat-map style table.

Daily Snapshots

SubPulse automatically captures daily snapshots to maintain an accurate historical record. Tracked data points include: active subscriber count, new subscribers, cancelled subscribers, total revenue, MRR, ARR, and churn rate.

SubRecover — Churn Recovery

Automate failed payment recovery with dunning sequences and prevent voluntary cancellations.

Overview

SubRecover helps you recover failed payments and prevent voluntary churn. Set up automated dunning sequences that retry payments, send reminder emails, and escalate recovery efforts — all on autopilot. Combined with cancellation prevention flows, SubRecover maximizes subscriber retention.

Dunning Sequences

Create multi-step recovery workflows that automatically handle failed payments.

Dunning Steps

Each step in a dunning sequence performs a specific action with configurable timing.

Recovery Tracking

Monitor the complete lifecycle of recovery attempts with detailed tracking and history.

Cancellation Prevention

Display configurable multi-step flows when customers attempt to cancel their subscriptions.

Recovery Analytics

SubBundle — Bundle Builder

Create build-a-box subscription bundles with flexible product selection and tiered pricing.

Overview

SubBundle lets you create subscription box experiences where customers can customize their orders. Offer fixed bundles with pre-set products or mix-and-match bundles where subscribers choose from your catalog. With tiered pricing, cycle management, and selection tracking, SubBundle powers the complete build-a-box workflow.

Bundle Types

Bundle Configuration

Tiered Pricing

Configure price tiers based on the number of items selected. Each tier has a minimum items threshold and a corresponding discount value. Tiered pricing encourages subscribers to add more items for better value.

Cycle Management

Each bundle operates on cycles with open, close, and ship dates. Merchants control when cycles open and close, allowing subscribers to make their selections during the OPEN window.

Selection Tracking & Stats

Subscribers choose products per cycle per bundle. Each selection is confirmed and stored with a timestamp. The system maintains one selection per subscriber per cycle using upsert logic.

SubLoyal — Loyalty & Rewards

Reward long-term subscribers with points, VIP tiers, referral bonuses, and milestone achievements.

Overview

SubLoyal turns subscribers into loyal advocates. Build a points-based loyalty program that rewards purchases, subscription tenure, and referrals. Create VIP tiers with exclusive perks, celebrate milestones with automatic rewards, and grow your subscriber base through referral incentives.

Points Engine

Point Transaction Types

VIP Tiers

Configure named tiers with minimum lifetime points thresholds. Each tier includes custom perks (free shipping, early access, exclusive products, etc.). Members automatically upgrade when they reach the next tier's points threshold.

Milestone Rewards

Configurable rewards triggered at subscription month thresholds. Each milestone has a months threshold, reward type, reward value, and badge name.

• Reward Types: POINTS (bonus points), FREE_PRODUCT, DISCOUNT
• Triggers: Subscription month thresholds (3 months, 6 months, 1 year, etc.)
• Tracking: Automatic duplicate prevention to ensure each milestone is awarded once
• Badge Names: Custom badge names celebrate subscriber achievements

Referral Program

Each member gets a unique 8-character referral code. When a referred customer subscribes, both parties earn points.

• Referral Codes: Unique 8-character codes per member
• Statuses: PENDING → REWARDED
• Point Distribution: Both referrer and referee earn configurable amounts
• Auto-Enrollment: Referee automatically joins loyalty program
• Tier Recalculation: Automatic tier updates after referral rewards

Member Management

Members are auto-enrolled when a subscription is created (if the loyalty program is active). Track points balance, lifetime points, current tier, and subscription months. Search members by name or email, filter by tier.

Customer Portal API

REST endpoints for customer self-service subscription management. Integrate with your Shopify theme or headless storefront.

Overview

The Customer Portal API provides 7 endpoints that enable subscribers to manage their subscriptions directly. These endpoints can be integrated into your Shopify theme's customer account pages or used in a headless storefront application. All endpoints are prefixed with /api/customer/subscriptions.

Endpoints

curl -X GET "https://your-store.myshopify.com/api/customer/subscriptions?customerId=gid://shopify/Customer/12345"

Response (200):
{
  "subscriptions": [
    {
      "id": "gid://shopify/AppSubscription/1",
      "status": "ACTIVE",
      "product": { "title": "Premium Coffee" },
      "frequency": { "interval": "MONTH", "intervalCount": 1 },
      "nextOrderDate": "2026-04-03T00:00:00Z"
    }
  ]
}

curl -X POST ".../subscriptions/{id}/pause" -H "Content-Type: application/json"

Response (200): { "status": "PAUSED", "pausedAt": "2026-03-03T14:22:00Z" }

curl -X POST ".../subscriptions/{id}/resume" -H "Content-Type: application/json"

Response (200): { "status": "ACTIVE", "nextOrderDate": "2026-04-03T00:00:00Z" }

curl -X POST ".../subscriptions/{id}/cancel" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Product no longer needed"}'

Response (200): { "status": "CANCELLED", "reason": "Product no longer needed" }

curl -X POST ".../subscriptions/{id}/skip" -H "Content-Type: application/json"

Response (200): { "skipped": true, "nextOrderDate": "2026-05-03T00:00:00Z" }

curl -X POST ".../subscriptions/{id}/swap" \
  -H "Content-Type: application/json" \
  -d '{"variantId":"gid://shopify/ProductVariant/789"}'

Response (200): { "variant": { "title": "2 lb Bag", "sku": "COFFEE-2LB" } }

curl -X POST ".../subscriptions/{id}/frequency" \
  -H "Content-Type: application/json" \
  -d '{"interval":"MONTH","intervalCount":2}'

Response (200): { "frequency": { "interval": "MONTH", "intervalCount": 2 } }

Status Codes

Integration Guide

Billing & Plans

Choose the right plan for your subscription business. All plans include zero transaction fees.

Overview

SubSuite offers four pricing tiers designed to grow with your business. Every plan includes SubFlow (core subscription management) with zero transaction fees. Unlock additional modules as add-ons based on your plan level.

Pricing Plans

Module Add-ons

SubSuite's feature set is built around a modular architecture. SubFlow (core) is included in every plan. Choose additional modules based on your plan:

Module selection can be changed at any time, with swap date restrictions to prevent mid-cycle abuse.

Plan Changes

Frequently Asked Questions