Skip to main content

Documentation Index

Fetch the complete documentation index at: https://app.docs.circuly.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

The circuly Subscriptions customer portal is an extension that lives inside your customers’ Shopify account page. It gives customers a self-service hub to view, manage, and take actions on their subscriptions — without needing to contact your support team.

​
What customers see

​
Subscription list

When customers visit their account, they see a list of all their subscriptions with key information at a glance:
  • Product name and image
  • Subscription status (Active, Paused, Cancelled, Expired, or Failed)
  • Billing frequency and pricing
Customers can search subscriptions by product name, variant, or subscription ID, and filter by status (All, Active, Cancelled, Paused) to quickly find what they’re looking for.

​
Subscription details

Clicking on a subscription opens the detail view, which includes:
  • Next action card — Shows what’s happening next (e.g., next billing date, upcoming delivery)
  • Subscription status — Current status, contract type, and next billing date
  • Subscription items — Product name, variant, quantity, SKU, and pricing
  • Billing & Delivery — Total per cycle, billing frequency, delivery schedule, and last payment status
  • Billing cycles — Billing schedule with dates, period ranges, and cycle status (collapsible)
  • Billing history — Past payments that were successfully billed, with amounts and dates (collapsible)
  • Customer information — Name and shipping address (collapsible)
  • Order history — The original order that created this subscription, with a link to view it

​
Available customer actions

From the subscription detail view, customers can take several actions depending on their subscription type and your configured policies. Each action is controlled by your settings — you decide what customers can and cannot do.
Customers can temporarily pause their subscription. While paused, no billing occurs. They can resume at any time.
If a subscription is paused, customers can reactivate it by clicking “Activate subscription” to resume billing on the next cycle.
Customers can cancel their subscription, subject to your cancellation policy. For example, you may require a minimum commitment period before cancellation is allowed.If cancellation isn’t available yet, customers see a message explaining when they’ll be able to cancel.Merchants can also cancel subscriptions on behalf of customers directly from the subscription detail page in the circuly admin panel, with options for immediate cancellation or at the end of the current billing cycle.
For consumable subscriptions, customers can skip the upcoming billing and delivery cycle while keeping the subscription active. The next cycle will proceed as scheduled. If a cycle has already been skipped, customers can unskip it to restore the original billing schedule.
Customers can swap the product in their subscription for a different product or variant. This is useful for changing sizes, colors, or switching to a different item entirely. Swap availability may be subject to a configured limit or cooldown period between swaps.
For rental subscriptions, customers can purchase the item outright by paying a buyout price. Once initiated, they are redirected to checkout to complete the payment.
For rental subscriptions, customers can initiate a return when their rental period ends.
Customers can update the payment method for their subscription by being directed to their Shopify account profile, where they can manage their saved payment methods.
Each action can be enabled or disabled based on your business rules. If an action is unavailable, customers see it as disabled with an explanation of why.

​
Enabling the customer portal

The customer portal is powered by a Shopify Customer Account UI Extension. It becomes available automatically once the app is installed and your Shopify store uses the new customer accounts.
1

Verify customer accounts are enabled

In your Shopify admin, go to Settings > Customer accounts and make sure you are using Shopify’s new customer accounts. The Customer Account UI Extension requires the new customer accounts experience — classic accounts are not supported.
2

Check the extension is active

Go to Settings > Customer accounts > Extensions in your Shopify admin. You should see the circuly Subscriptions extension listed and enabled.
3

Test the portal

Log in to your storefront as a customer with an active subscription. Navigate to your account page — you should see the Subscriptions section.

​
Order action menu item

In addition to the full portal, customers also see a “View subscriptions” action in the order menu when viewing orders that were created by a subscription. Clicking this navigates to the subscriptions portal filtered to show the subscription associated with that order.