# Getting started with Subrise Subscriptions Welcome to Subrise Subscriptions, the definitive tool for elevating your Shopify store with a subscription model that not only retains customers but also scales your business effectively. This guide is crafted to help you navigate the setup, management, and optimization of your subscription service with ease and precision. ### Getting Started Lets walk you through how Subrise can make your business management easier. * [Installation](#getting-started) ### Onboarding * [Dashboard Overview](/guide/dashboard-overview) ### Manage your Subscriptions All you need to know about creating your subscription plans and being familiar with Subrise * [Creating Subscription plans](/guide/subscription-setup/creating-your-subscription-plan) * [Managing your Subscription](https://app.gitbook.com/o/2jpS98KFHkCTi0SD09JA/s/oNYxxCzbbZsdqiP7Nha8/~/changes/11/guide/subscription-setup/managing-your-subscription) ### Settings Deep dive into the settings to fine-tune your subscription service: * [Tag management](https://app.gitbook.com/o/2jpS98KFHkCTi0SD09JA/s/oNYxxCzbbZsdqiP7Nha8/~/changes/11/guide/settings#manage-information-with-ease-tag-management) * [Email Editor](https://app.gitbook.com/o/2jpS98KFHkCTi0SD09JA/s/oNYxxCzbbZsdqiP7Nha8/~/changes/11/guide/settings/notifications) * [Webhooks](https://app.gitbook.com/o/2jpS98KFHkCTi0SD09JA/s/oNYxxCzbbZsdqiP7Nha8/~/changes/11/guide/settings/webhooks) * [Billing Settings](https://app.gitbook.com/o/2jpS98KFHkCTi0SD09JA/s/oNYxxCzbbZsdqiP7Nha8/~/changes/11/guide/settings#billing-settings) ### Theme Extension * [Subrise Product Widget](https://app.gitbook.com/o/2jpS98KFHkCTi0SD09JA/s/oNYxxCzbbZsdqiP7Nha8/~/changes/11/guide/theme-extension) * [Customer subscription Portal](https://app.gitbook.com/o/2jpS98KFHkCTi0SD09JA/s/oNYxxCzbbZsdqiP7Nha8/~/changes/11/guide/settings/customer-portal) ### Integrations *Learn how to integrate Subrise with leading ecommerce tech partners.* * [Klaviyo Integration](/guide/settings/integrations/klaviyo-integration) * [Zapier Integration](/guide/settings/integrations/zapier-integration) * [Mailchimp Integration](/guide/settings/integrations/mailchimp-integration) * [Google Sheets Integration](/guide/settings/integrations/google-sheets-integration) * [Gorgias Integration](/guide/settings/integrations/gorgias-integration) # Dashboard Overview The Subrise Subscription dashboard shows a detailed and clear snapshot of the subscriptions, customers, and revenue that you have accumulated. The dashboard is your central hub for insights and actions.

#### Key Metrics at a Glance This section of the dashboard provides a quick overview of your subscription performance. See your total sales, revenue generated, new subscriptions acquired, and new customers all in one place.

#### Subscription & Customer Growth Trends These charts visualize your customer acquisition and subscription growth over time. See how many new subscriptions you're gaining daily and how your customer base is expanding.

#### **Subscription Management Insights** Dive deeper into your subscription health with these charts. Analyze your subscription status distribution (active, paused, canceled), view recent subscriptions, and understand why customers might be pausing or canceling.

The Subrise Subscription dashboard equips you with the tools and insights you need to manage and optimize your subscription business effectively. Gain a clear view of your key metrics, analyze customer acquisition trends, and identify areas for improvement in your subscription plans and retention strategies. By leveraging the actionable insights provided by the dashboard, you can make data-driven decisions to drive growth, improve customer satisfaction, and achieve sustainable subscription success. # Reports Keeping track of reports is essential for monitoring subscription activity, identifying trends, and making data-driven decisions. ## The Reports dashboard at a glance The Subrise Reports dashboard is an organised library providing insights into various subscription activity aspects. Here is an overview of what it does and how to make the best out of it.

### Reports Overview The Reports dashboard includes the following report categories: * **New Subscribers** - List of newly subscribed users with subscription details. * **Reasoned Cancellations** - Insights into why customers have permanently canceled subscriptions. * **Reasoned Pauses** - Analysis of temporary subscription pauses initiated by customers * **Line Items** - Breakdown of line items and add-ons in active and prepaid subscriptions * **Failed Billing** - Reports on failed billing attempts with customer and subscription details. * **Prepaid Subscriptions** - Overview of prepaid subscriptions, including customer, product, and billing information. ### Report Actions Each Reports type has two action buttons that help streamline subscription management: * **View Report:** Action leads you to the Report details page to access real-time data and insights. * **Schedule Report**: This button generates automated reports based on your specifications. ### Report Details The Report Details page provides a comprehensive overview and offers real-time insights on the type of report selected. It also houses action buttons that help with sorting, filtering, and the recovery of subscriber reports. These buttons include: * **All Time**: This helps to filter reports by period. * **Schedule Report**: Action to extract automated report based on your preference. * **Export Report**: Action for quick downloading of the report.

#### All Time Action (Filter Report) Want to get reports based on a particular date or time range, the "All Time" action button got you covered. This provides you with a calendar and various options to quickly filter reports based on your preferred date.

### Schedule Report Reports can be automatically generated and sent from your Subrise account to your preferred email. You can choose how frequently you want to receive your updates: Daily, Weekly, or Monthly.

#### My Scheduled Reports The My Scheduled Reports section displays all scheduled reports for automatic generation. This section helps you track your scheduled reports, modify them, or remove them if necessary.

### Reports History The Reports History dashboard provides an overview of previously generated reports, allowing you to access past data efficiently.

Each report entry includes the following details: * **Report Name**: The file name of the exported report. * **Date Range**: The period covered by the report. * **Recipients**: The delivery method (e.g., Direct Export). * **Date Generated**: The date the report was created. #### Report History Actions You can take the following actions on the historical reports: * **Download**: Click the download icon to quickly obtain a copy of the report. * **View**: The View icon enables you to preview the report contents. * **Resend**: To resend reports, click the resend icon. # Subscription Setup Creating and managing subscription plans is a pivotal aspect of Subrise Subscriptions. This guide will walk you through the intricacies of setting up your plans, ensuring you're well-equipped to offer a compelling subscription service to your customers. Let's break down everything you need to know about Subscription Plans. ### Understanding Subscription Plans Subscription Plans are the backbone of your subscription model, defining how and when your customers are billed and receive your products. A well-structured plan can significantly enhance customer retention and revenue stability. Here's what you need to know to create an effective plan. #### Billing Frequency vs. Order Frequency * **Billing Frequency:** This determines how often your customers are charged for their subscriptions. Common intervals include monthly, quarterly, or annually. * **Order Frequency:** This specifies how often orders are shipped to your customers. Like billing frequency, this can be set to various intervals. **Syncing Frequencies** Subscription Plans can have synced or divisible frequencies, depending on how you wish to bill and fulfill orders: * **Synced:** Billing and order frequencies match (e.g., charged and shipped monthly). * **Divisible:** Billing frequency is longer than order frequency (e.g., charged every 3 months but shipped monthly). #### Discounts and Incentives Offering discounts can significantly boost the attractiveness of your subscription plans: * **Fixed Discount:** Apply a constant discount rate to your subscription plan. This can be a percentage off or a fixed amount. * **Discount Cycles:** Implement discounts that apply for a set number of billing cycles, encouraging longer subscription commitments. # Creating your Subscription Plan Subscription Plans are the backbone of your subscription model, defining how and when your customers are billed and receive your products. A well-structured plan can significantly enhance customer retention and revenue stability. Here's how to create an effective plan. You can choose to use the available templates when creating your subscription plans or to create them from scratch.

### Choose a Template (Optional) or Create a New Plan Subrise offers pre-built templates for common subscription models (weekly deliveries, monthly memberships) to jumpstart your plan creation. You can also create a plan entirely from scratch.

Fill in the Subscription Details Subscription Plan Title: Give your plan a clear and descriptive name. Selling method : Choose how you want your customers to subscribe. The option chosen here will determine the billing and delivery method.

Billing and Delivery: Determine when customers are billed and when they receive their products.

**(Optional) Apply Discounts****:** Incentivize longer commitments by offering discounts for upfront payments or longer subscription terms. If you choose to apply a recurring discount, then you have tyhe option to set how many charges you want the discount to last.

### Advanced Settings From the advanced settings, you have the option to implement a billing and delivery anchor. Billing and Deliver Anchor: This allows you to move all new subscription orders to the next cycle after the cutoff after the first order. You can choose a cut-off day and an anchor day, and this option will take all subscription orders after the cutoff day and populate it to the anchor day. An example is If you set the cut-off to the 21st of the month and set the anchor day to the 1st, then all orders after the 21st will populate on the 1st on its next cycle, which is roughly 39 days from its first order.

Before finalizing, add a group title, choose a plan option and preview your plan to ensure all details are accurate. Once you are satisfied, save your subscription plan and start offering it to your customers.

#### Product Management An essential part of setting up your subscription plan is selecting which products are available for subscription. To do that, select the product tab in the preview corner.

* **Adding Products:** Choose individual products that will be part of the subscription plan. This can range from a single product to multiple ones, depending on your strategy.

* **Bulk Sync:** Streamline the process by connecting entire collections to a subscription plan. This is particularly useful for stores with a wide range of products, allowing for efficient management.

### Best Practices * **Experiment with Frequencies:** Test different billing and order frequencies to find what resonates best with your audience. * **Clear Communication:** Ensure your subscription terms, especially around discounts and billing cycles, are clearly communicated to avoid customer confusion. * **Feedback Loop:** Regularly gather feedback from your subscribers to refine and improve your subscription plans over time. By following these steps, you'll be well on your way to creating compelling subscription plans that drive customer loyalty and revenue growth. # Managing your Subscription Efficiently managing subscriptions is crucial for customer satisfaction and a thriving subscription business. Subrise Subscriptions empowers you to easily view and modify subscriber details directly from your admin dashboard. This guide will walk you through the Subscription List and Edit pages, equipping you with the tools to keep your subscription service running smoothly. ### Your Central Hub: The Subscription List The Subscription List page acts as your control tower for overseeing all customer subscriptions. Here’s how you can make the most of it:

#### Navigating the Subscription List The Subscription List page acts as your central hub for overseeing all customer subscriptions. Here, you can perform key actions: * **Filter by Status:** Easily review active, pending, paused, or cancelled subscriptions to focus on specific needs. * **Drill Down for Details:** Click on a specific subscription to access the Edit page. ### Edit Subscriptions with Ease The Subscription Edit page allows you to fine-tune various aspects of a subscription to accommodate customer requests or operational changes.

* **Add-Ons:** Enhance a customer’s subscription by adding additional products or services. This is a great way to increase value and revenue. Add ons are products that will be added to a subscription for only a limited number of billing cycles, usually one.

* **Modify Subscription Content:** Add extra products, change quantities, or swap items within the subscription.

* **Billing & Payment:** * Change Payment Method: Update the payment method associated with the subscription.

* Change Billing Date: Adjust the next billing date for customer requests or billing cycle changes.

* **Note:** Updating payment methods requires sending a secure payment link to the customer so they can input their details.

* **Delivery & Customization:** * Shipping Address Modification: Update the customer's shipping address for seamless delivery.

* Edit Order Notes and Attributes: Tailor upcoming orders with personalized notes and details.

**Best Practices for Stellar Subscription Management:** * **Communicate Changes:** Keep customers informed about any subscription edits for transparency. * **Monitor Add-Ons:** Track the performance of add-on items to optimize your offerings. * **Flexible Billing:** Offer flexibility on billing dates to enhance customer satisfaction. * **Proactive Address Verification:** Monitor delivery success rates and contact customers for address confirmation to prevent delivery issues. * **Customization is Key:** Utilize notes and attributes to provide tailored experiences, reinforcing the value of your subscription service. **Conclusion:** By mastering the Subscription List and Edit pages and following these best practices, you'll be well-equipped to manage and customize customer subscriptions effectively. This ensures that your subscription service exceeds customer expectations, leading to long-term loyalty and business growth. # Settings Subrise Subscriptions empowers you to customize and optimize your subscription service with a comprehensive set of settings. This guide explores some key settings that can help you manage your subscriptions effectively. ### Manage Information with Ease: Tag Management Tags are like digital sticky notes that you can use to categorize your subscriptions. To suit your specific needs, assign tags to active subscriptions, new signups, or paused plans. This allows for efficient organization, filtering, and searching within your subscription data.

### Billing Settings Billing settings allow you to customize and choose specific billing days and times for your customers.

By mastering Subrise Subscription settings, you gain the power to create a well-organized, efficient, and customer-centric subscription service. Don't hesitate to experiment and adjust settings based on your specific needs to unlock the full potential of Subrise Subscriptions and drive your business forward. # Integrations Integrations allow you to connect Subrise to your existing services, giving you the ability to collaborate with external services. Seamlessly connect your Subrise account to our many integrations. # Attentive Integration Follow the steps below to setup the Attentive Integration. ## Log into your Existing Attentive Account

Log into your Attentive account and head to the main dashboard.

## Head to your Marketplace page in Attentive to create a new app

Head to marketplace to create a custom attentive app

## Create a Custom App named Subrise Subscriptions

Name your app Subrise Subscriptions, and set the permissions as such.

## Grab the API Key From The Subrise App

## Head to the Subrise App, and go to Settings Tab

Click the "Attentive" integrations card, and paste in the API Key from the custom Attentive App.

## Set Up a New Attentive Journey

## Choose from one of our Many Subrise Event Triggers

## You are now connected to Attentive through Subrise! *** ## Datatypes and Events The Subrise Subscription application, will send subscription-based data to your Attentive account for a variety of different Events. Below are the following Events you can expect to receive data for, as well as the format of that data. ### Events * [New Subscription](#new-subscription-payload) * [New Subscriber](#new-subscriber-payload) * [Subscription Cancelled](#subscription-cancelled-payload) * [Subscription Modified](#subscription-modified) * [Upcoming Invoice](#upcoming-invoice-payload) * [Failed Transaction](#failed-transaction-payload) * [Successful Payment](#successful-payment-payload) * [Pause Subscription](#pause-subscription-payload) * [Reactivated Subscription](#reactivated-subscription-payload) * [Prepaid Subscription](#prepaid-subscription-payload) * [Addon Subscription](#addon-subscription-payload) ### New Subscription Payload ``` { metric: "subrise_new_subscription", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", subscription_line_items: [ { variant_title: blue shirt, price: 1.99, quantity: 1, discounted_price: 1.99, }, ], total_subscription_price: 1.99, subscription_started_date: "2024-05-14T17:52:47.910Z", } ``` ### New Subscriber Payload ``` { metric: "subrise_new_subscriber", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", subscription_total: 1.99, subscription_started: "2024-05-14T17:52:47.910Z", subscription_line_items: [ { variant_title: blue shirt, price: 1.99, quantity: 1, discounted_price: 1.99, }, ] } ``` ### Subscription Cancelled Payload ``` { metric: "subrise_subscription_cancelled", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", reason: "too good", reason_details: "The deal was too good", total_subscription_orders: 1, subscription_cancelled_date: "2024-05-14T17:52:47.910Z", } ``` ### Subscription Modified *updatedField, and updatedValue will correspond to the different fields that may or may not get updated on a Subscription object.* ``` { metric: "subrise_subscription_modified", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", subscription_modified_date: "2024-05-14T17:52:47.910Z", updatedField1:"deliveryInterval", updatedValue1:"MONTH", updatedField2:"deliveryIntervalCount", updatedValue2:1, updatedField3:"billingInterval". updatedValue3:"MONTH", updatedField4:"billingIntervalCount", updatedValue4:1, updatedField5:"maxCycles", updatedValue5:NULL, updatedField6:"minCycles", updatedValue6:NULL, updatedField7:"isPrepaid", updatedValue7:false, } ``` ### Upcoming Invoice Payload ``` { metric: "subrise_upcoming_invoice", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", subscription_invoice_date: "2024-05-14T17:52:47.910Z", } ``` ### Failed Transaction Payload ``` { metric: "subrise_failed_transaction", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", total_subscription_price: 1.99 failed_billing_error_message: "error", card_info: 1234, } ` ``` ### Successful Payment Payload ``` { metric: "subrise_successful_payment", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", total_subscription_price: 1.99 payment_date: "2024-05-14T17:52:47.910Z", } ``` ### Pause Subscription Payload ``` { metric: "subrise_pause_subscription", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", pause_reason: "price", pauseDetails: "Could not afford this anymore", total_subscription_orders: 3, subscription_paused_date: "2024-05-14T17:52:47.910Z" } ``` ### Reactivated Subscription Payload ```` { metric: "subrise_reactivate_sub", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", total_subscription_price: 1.99 subscription_updated_date: "2024-05-14T17:52:47.910Z" } ``` ```` ### Prepaid Subscription Payload ```` { metric: "subrise_prepaid_subscription", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", total_subscription_price: 1.99, subscription_started: "2024-05-14T17:52:47.910Z", subscription_line_items: [ { variant_title: blue shirt, price: 1.99, quantity: 1, discounted_price: 1.99, }, ] } ``` ```` ### Addon Subscription Payload ``` { metric: "subrise_addon_purchase", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", subscription_total: 1.99, subscription_started: "2024-05-14T17:52:47.910Z", addon_line_items: [ { variant_title: blue shirt, price: 1.99, quantity: 1, discounted_price: 1.99, }, ] } ``` # Shopify Flow The Subrise Integration with Shopify Flow allows the merchant to "visually-code" events and custom triggers to perform various tasks. Flow gives you the a lot of power for custom shop events!

In this example the Merchant can Add custom tags when a subscription is paused, and the pause reason = "Too Expensive"

## How Do I Use It? The two main components of Shopify Flow are Triggers and Actions. Shopify comes with a ton of they're own custom triggers and actions, and we at Subrise also have created our own custom ones as well that will work with Shopify's. When a Trigger occurs (New Subscription) you can assign that trigger a Action (Tag Customer, or Send an Email, or Add Or Remove Certain Products) ## Subrise Triggers When the following triggers below happen on your shop they will send subscription data, to the action you have assigned it in the Shopify Flow Workflow. ### Cancelled Subscription This Trigger will fire off an action when a subscription is cancelled. ### Failed Billing This Trigger will fire off an action when a subscription billing fails. ### New Subscriber This Trigger will fire off an action when your shop gets a new Subscriber. ### New Subscription This Trigger will fire off an action when your shop gets a new Subscription. ### Paused Subscription This Trigger will fire off an action when a subscription is paused. ### Prepaid Subscription This Trigger will fire off an action when a prepaid subscription has been created. ### Subscription Resumed This Trigger will fire off an action when a subscription is resumed. ### Subscription Addons This Trigger will fire off an action when a Add-On has been added to a subscription. ### Subscription Modified This Trigger will fire off an action when a subscription has been upated/modified by either the admin or a customer. ### Successful Payment This Trigger will fire off an action when a subscription has been billed successfully. ### Upcoming Subscription This Trigger will fire off an action when a subscription will be billed within 48 hours. ## Subrise Actions These are only the actions we offer custom from our app, but Shopify Flow has hundreds of built-in actions to perform various tasks in your shop. We recommend looking at the Shopify Flow docs to get a larger idea of what's capable. If you can imagine it, it's probably possible. {% embed url="" %} ### Add Subscription Line Item This Action will add a variant to a Subscription. ### Cancel Subscription This Action will cancel a subscription contract. ### Pause Subscription This action will pause a subscription contract. ### Remove Line Item From Subscription This action can remove a Line Item from a subscription contact. ### Resume Subscription This action can Resume a subscription contract. ### Run Billing Now This action will run billing on a subscription contract. ### Set Next Billing Date This action will set the billing date on a subscription to a new date of your choosing. ### Skip Next Billing Date This action will skip the billing, and not run till the next billing date. # Klaviyo Integration Watch our video below, or follow our step by step instruction on setting up the Subrise Subscription app with your Klaviyo account. {% embed url="" %} ## Log into your Existing Klaviyo Account or Create one

Create a new Klaviyo account or log into your existing one, and head to "Account Plans"

## Head to your Settings page in Klaviyo to create a new API Key

Once your inside "Account Plans" Click the "Account" tab, and choose "API keys" from the dropdown

Set your Key restrictions and Create the API Key

Copy your API key, keep this private. (Note: our example key was deleted, so it is safe to show)

## Head to the Subrise App, and go to Settings Tab

On Settings tab in Subrise app, click the "Integrations" tab.

## Paste your Klaviyo API Key

Once here, Paste your new API Key, and thats it!

## You are now connected to Klaviyo through Subrise! #### View Klaviyo Metrics

Click into Analytics > Metrics > "View Activity Feed" To see your Subrise Events

*** ## Datatypes and Events The Subrise Subscription application, will send subscription-based data to your Klaviyo account for a variety of different Events. Below are the following Events you can expect to receive data for, as well as the format of that data. ### Events * [New Subscription](#new-subscription-payload) * [New Subscriber](#new-subscriber-payload) * [Subscription Cancelled](#subscription-cancelled-payload) * [Subscription Modified](#subscription-modified) * [Upcoming Invoice](#upcoming-invoice-payload) * [Failed Transaction](#failed-transaction-payload) * [Successful Payment](#successful-payment-payload) * [Pause Subscription](#pause-subscription-payload) * [Reactivated Subscription](#reactivated-subscription-payload) * [Prepaid Subscription](#prepaid-subscription-payload) * [Addon Subscription](#addon-subscription-payload) ### New Subscription Payload ``` { metric: "subrise_new_subscription", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", subscription_line_items: [ { variant_title: blue shirt, price: 1.99, quantity: 1, discounted_price: 1.99, }, ], total_subscription_price: 1.99, subscription_started_date: "2024-05-14T17:52:47.910Z", } ``` ### New Subscriber Payload ``` { metric: "subrise_new_subscriber", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", subscription_total: 1.99, subscription_started: "2024-05-14T17:52:47.910Z", subscription_line_items: [ { variant_title: blue shirt, price: 1.99, quantity: 1, discounted_price: 1.99, }, ] } ``` ### Subscription Cancelled Payload ``` { metric: "subrise_subscription_cancelled", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", reason: "too good", reason_details: "The deal was too good", total_subscription_orders: 1, subscription_cancelled_date: "2024-05-14T17:52:47.910Z", } ``` ### Subscription Modified *updatedField, and updatedValue will correspond to the different fields that may or may not get updated on a Subscription object.* ``` { metric: "subrise_subscription_modified", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", subscription_modified_date: "2024-05-14T17:52:47.910Z", updatedField1:"deliveryInterval", updatedValue1:"MONTH", updatedField2:"deliveryIntervalCount", updatedValue2:1, updatedField3:"billingInterval". updatedValue3:"MONTH", updatedField4:"billingIntervalCount", updatedValue4:1, updatedField5:"maxCycles", updatedValue5:NULL, updatedField6:"minCycles", updatedValue6:NULL, updatedField7:"isPrepaid", updatedValue7:false, } ``` ### Upcoming Invoice Payload ``` { metric: "subrise_upcoming_invoice", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", subscription_invoice_date: "2024-05-14T17:52:47.910Z", } ``` ### Failed Transaction Payload ``` { metric: "subrise_failed_transaction", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", total_subscription_price: 1.99 failed_billing_error_message: "error", card_info: 1234, } ` ``` ### Successful Payment Payload ``` { metric: "subrise_successful_payment", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", total_subscription_price: 1.99 payment_date: "2024-05-14T17:52:47.910Z", } ``` ### Pause Subscription Payload ``` { metric: "subrise_pause_subscription", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", pause_reason: "price", pauseDetails: "Could not afford this anymore", total_subscription_orders: 3, subscription_paused_date: "2024-05-14T17:52:47.910Z" } ``` ### Reactivated Subscription Payload ```` { metric: "subrise_reactivate_sub", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", total_subscription_price: 1.99 subscription_updated_date: "2024-05-14T17:52:47.910Z" } ``` ```` ### Prepaid Subscription Payload ```` { metric: "subrise_prepaid_subscription", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", total_subscription_price: 1.99, subscription_started: "2024-05-14T17:52:47.910Z", subscription_line_items: [ { variant_title: blue shirt, price: 1.99, quantity: 1, discounted_price: 1.99, }, ] } ``` ```` ### Addon Subscription Payload ``` { metric: "subrise_addon_purchase", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", subscription_total: 1.99, subscription_started: "2024-05-14T17:52:47.910Z", addon_line_items: [ { variant_title: blue shirt, price: 1.99, quantity: 1, discounted_price: 1.99, }, ] } ``` # Zapier Integration Watch our video below, or follow our step by step instruction on setting up the Subrise Subscription app with your Zapier account. {% embed url="" %} ## Log into your Existing Zapier Account or Create one ### Create a new Zap

Once logged in Click "Create" and then click "Zaps"

### Select a Trigger for you Zap

Choose Trigger an Event that Starts the Zap

### Select Webhook as your Trigger type

### Select and "Event", and choose "Catch Hook" as the option.

### Copy the Webhook URL

### Paste Webhook Url into Subrise Subscription App

Paste your webhook url, and click "Connect" or "Update" to connect the app to Zapier

### Get the Subrise Data sent to your Zapier Account

Congrats You're now getting Subrise Data

## Event Types and Payloads The Subrise Subscription application, will send subscription-based data to your Zapier account for a variety of different Events. Below are the following Events you can expect to receive data for, as well as the format of that data. ### Events * [New Subscription](#new-subscription-payload) * [New Subscriber](#new-subscriber-payload) * [Subscription Cancelled](#subscription-cancelled-payload) * [Subscription Modified](#subscription-modified) * [Upcoming Invoice](#upcoming-invoice-payload) * [Failed Transaction](#failed-transaction-payload) * [Successful Payment](#successful-payment-payload) * [Pause Subscription](#pause-subscription-payload) * [Reactivated Subscription](#reactivated-subscription-payload) * [Prepaid Subscription](#prepaid-subscription-payload) * [Addon Subscription](#addon-subscription-payload) ### New Subscription Payload ``` { metric: "subrise_new_subscription", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", subscription_line_items: [ { variant_title: blue shirt, price: 1.99, quantity: 1, discounted_price: 1.99, }, ], total_subscription_price: 1.99, subscription_started_date: "2024-05-14T17:52:47.910Z", } ``` ### New Subscriber Payload ``` { metric: "subrise_new_subscriber", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", subscription_total: 1.99, subscription_started: "2024-05-14T17:52:47.910Z", subscription_line_items: [ { variant_title: blue shirt, price: 1.99, quantity: 1, discounted_price: 1.99, }, ] } ``` ### Subscription Cancelled Payload ``` { metric: "subrise_subscription_cancelled", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", reason: "too good", reason_details: "The deal was too good", total_subscription_orders: 1, subscription_cancelled_date: "2024-05-14T17:52:47.910Z", } ``` ### Subscription Modified *updatedField, and updatedValue will correspond to the different fields that may or may not get updated on a Subscription object.* ``` { metric: "subrise_subscription_modified", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", subscription_modified_date: "2024-05-14T17:52:47.910Z", updatedField1: "deliveryInterval", updatedValue1: "MONTH", updatedField2: "deliveryIntervalCount", updatedValue2: 1, updatedField3: "billingInterval". updatedValue3: "MONTH", updatedField4: "billingIntervalCount", updatedValue4: 1, updatedField5: "maxCycles", updatedValue5: NULL, updatedField6: "minCycles", updatedValue6: NULL, updatedField7: "isPrepaid", updatedValue7: false, } ``` ### Upcoming Invoice Payload ``` { metric: "subrise_upcoming_invoice", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", subscription_invoice_date: "2024-05-14T17:52:47.910Z", } ``` ### Failed Transaction Payload ``` { metric: "subrise_failed_transaction", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", total_subscription_price: 1.99 failed_billing_error_message: "error", card_info: 1234, } ` ``` ### Successful Payment Payload ``` { metric: "subrise_successful_payment", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", total_subscription_price: 1.99 payment_date: "2024-05-14T17:52:47.910Z", } ``` ### Pause Subscription Payload ``` { metric: "subrise_pause_subscription", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", pause_reason: "price", pauseDetails: "Could not afford this anymore", total_subscription_orders: 3, subscription_paused_date: "2024-05-14T17:52:47.910Z" } ``` ### Reactivated Subscription Payload ```` { metric: "subrise_reactivate_sub", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", total_subscription_price: 1.99 subscription_updated_date: "2024-05-14T17:52:47.910Z" } ``` ```` ### Prepaid Subscription Payload ```` { metric: "subrise_prepaid_subscription", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", total_subscription_price: 1.99, subscription_started: "2024-05-14T17:52:47.910Z", subscription_line_items: [ { variant_title: blue shirt, price: 1.99, quantity: 1, discounted_price: 1.99, }, ] } ``` ```` ### Addon Subscription Payload ``` { metric: "subrise_addon_purchase", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", subscription_total: 1.99, subscription_started: "2024-05-14T17:52:47.910Z", addon_line_items: [ { variant_title: blue shirt, price: 1.99, quantity: 1, discounted_price: 1.99, }, ] } ``` # Mailchimp Integration Watch our video below, or follow our step by step instruction on setting up the Subrise Subscription app with your Mailchimp account. {% embed url="" %} ## Create an Account with Mailchimp or Login to Existing ### Create a new API Key in account settings

### Create a List ID, also known as Audience ID

The List Id, can be found inside Audience > Settings

### Connect to Subrise

Enter you API Key and List ID (Audience ID) into Subrise

### Receive Subrise Data to Mailchimp!

## Event Types and Payloads The Subrise Subscription application, will send subscription-based data to your Mailchimp account for a variety of different Events. Below are the following Events you can expect to receive data for, as well as the format of that data. ### Events * [New Subscription](#new-subscription-payload) * [New Subscriber](#new-subscriber-payload) * [Subscription Cancelled](#subscription-cancelled-payload) * [Subscription Modified](#subscription-modified) * [Upcoming Invoice](#upcoming-invoice-payload) * [Failed Transaction](#failed-transaction-payload) * [Successful Payment](#successful-payment-payload) * [Pause Subscription](#pause-subscription-payload) * [Reactivated Subscription](#reactivated-subscription-payload) * [Prepaid Subscription](#prepaid-subscription-payload) * [Addon Subscription](#addon-subscription-payload) ### New Subscription Payload ``` { metric: "subrise_new_subscription", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", subscription_line_items: [ { variant_title: blue shirt, price: 1.99, quantity: 1, discounted_price: 1.99, }, ], total_subscription_price: 1.99, subscription_started_date: "2024-05-14T17:52:47.910Z", } ``` ### New Subscriber Payload ``` { metric: "subrise_new_subscriber", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", subscription_total: 1.99, subscription_started: "2024-05-14T17:52:47.910Z", subscription_line_items: [ { variant_title: blue shirt, price: 1.99, quantity: 1, discounted_price: 1.99, }, ] } ``` ### Subscription Cancelled Payload ``` { metric: "subrise_subscription_cancelled", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", reason: "too good", reason_details: "The deal was too good", total_subscription_orders: 1, subscription_cancelled_date: "2024-05-14T17:52:47.910Z", } ``` ### Subscription Modified *updatedField, and updatedValue will correspond to the different fields that may or may not get updated on a Subscription object.* ``` { metric: "subrise_subscription_modified", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", subscription_modified_date: "2024-05-14T17:52:47.910Z", updatedField1: "deliveryInterval", updatedValue1: "MONTH", updatedField2: "deliveryIntervalCount", updatedValue2: 1, updatedField3: "billingInterval". updatedValue3: "MONTH", updatedField4: "billingIntervalCount", updatedValue4: 1, updatedField5: "maxCycles", updatedValue5: NULL, updatedField6: "minCycles", updatedValue6: NULL, updatedField7: "isPrepaid", updatedValue7: false, } ``` ### Upcoming Invoice Payload ``` { metric: "subrise_upcoming_invoice", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", subscription_invoice_date: "2024-05-14T17:52:47.910Z", } ``` ### Failed Transaction Payload ``` { metric: "subrise_failed_transaction", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", total_subscription_price: 1.99 failed_billing_error_message: "error", card_info: 1234, } ` ``` ### Successful Payment Payload ``` { metric: "subrise_successful_payment", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", total_subscription_price: 1.99 payment_date: "2024-05-14T17:52:47.910Z", } ``` ### Pause Subscription Payload ``` { metric: "subrise_pause_subscription", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", pause_reason: "price", pauseDetails: "Could not afford this anymore", total_subscription_orders: 3, subscription_paused_date: "2024-05-14T17:52:47.910Z" } ``` ### Reactivated Subscription Payload ```` { metric: "subrise_reactivate_sub", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", total_subscription_price: 1.99 subscription_updated_date: "2024-05-14T17:52:47.910Z" } ``` ```` ### Prepaid Subscription Payload ```` { metric: "subrise_prepaid_subscription", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", total_subscription_price: 1.99, subscription_started: "2024-05-14T17:52:47.910Z", subscription_line_items: [ { variant_title: blue shirt, price: 1.99, quantity: 1, discounted_price: 1.99, }, ] } ``` ```` ### Addon Subscription Payload ``` { metric: "subrise_addon_purchase", customer_first_name: "John", customer_last_name: "Doe", customer_email: "johndoe@test.com", customer_phone: "444-444-4444", customer_id: "12345678910" subscription_id: "12345678910", subscription_total: 1.99, subscription_started: "2024-05-14T17:52:47.910Z", addon_line_items: [ { variant_title: blue shirt, price: 1.99, quantity: 1, discounted_price: 1.99, }, ] } ``` # Google Sheets Integration {% embed url="" %} Its as easy as clicking "Connect" {% endembed %} ## Just Click "Connect" and "View Sheet"

Use your new Sheet data any way you desire, to tack real time Subscription Data updates!

# Gorgias Integration The below steps will take you through Gorgias integration on Subrise. Make sure you have the Gorgias app installed on your store and have completed your Gorgias account setup. 1. Navigate to the Settings page in the Subrise Subscriptions app

2. Navigate to the Integrations tab on the Settings page

3. Locate the Gorgias card on the Integrations tab and click 'Connect'

4. Find your Gorgias domain. It should look something like this:

5. Enter your Gorgias domain into the input field and click 'Connect'

6. Authorize Subrise Subscriptions through Gorgias OAuth

7. Success! You should see a window that looks like this:

Now that you have successfully connected your Gorgias account to Subrise you will have access to customer information widgets and direct links to customer pages in Gorgias. # Notifications The Email Editor settings allow you to design the look and feel of emails sent to your customers throughout their subscription journey. Preview your creations before sending them to ensure a professional and branded experience. You can customize emails for various events, including: * Welcome email: Introduce new subscribers and highlight your service benefits. * Renewal reminders: Nudge customers about upcoming renewals to prevent churn. * Cancellation confirmation: Acknowledge cancellations and potentially offer win-back incentives. * Order updates: Keep customers informed with timely shipment confirmation and tracking details.

# Tags In Subrise we offer custom tags, to help you better track both Customers, and Orders. ### Create Custom Tags for Customers and Orders

Seperate the Tags by a "," (comma) to add multiple tags to single topic

## Customer Tags

Example of Active Tags on a Customer Account

### First Time Subscriber This tag will be applied to all customers who are first time subscribers to your shop. ### Active Subscriber This tag will be applied to all customers with active subscriptions (Not paused, not cancelled) ### Inactive Subscriber This tag will be applied to all customers who have no active subscriptions (All subscriptions are cancelled) ### Paused Subscriber This tag will be applied to all customer who have no Actice Subscriptions (All subscriptions are paused) ## Order Tags

### Prepaid Orders This tag will be applied to all orders that contain a prepaid subscription. ### All Subscription Orders This tag will be applied to all orders that contain a subscription. ### New Subscription Orders This tag will be applied to all orders that are the first billed order of a new subscription ### Repeat Subscription Orders This tag will be applied to all orders that are repeat customers ordering the same items on a subscription. ## Advanced Tags For more advanced tag features we have integrated with Shopify Flow, which will allow you to set custom tag events, such as tagging orders or customers when certain products are purchased.\ Please refer to our Docs on the Shopify Flow Integrations to see how this is possible. # Webhooks Webhooks act as communication bridges between Subrise Subscriptions and other applications you use. When specific events occur (e.g., a new subscription or a paused subscription), Subrise can send real-time notifications to other applications. You can configure these notifications to trigger automated actions in those applications, streamlining workflows and saving you time. For example, a webhook can update customer status in your CRM upon a subscription cancellation.

# Customer Portal Empower your customers with a self-service portal. This will allow them to manage their subscriptions directly, enhancing their experience and reducing your customer service load. To create this portal, navigate to the Installation tab on the Settings Page in Subrise and click on Customize Customer Portal button.

You will be directed to the customer portal editor

Click on the Home Page dropdown, then on Pages, and then select Create Template. Create a name for the template and then click on Create Template as shown below:

With that done, navigate to the Sales Channel section and then the Plans page under the Online Store tab.

Click on Add Page

Give the Page a title and then assign it to the template we created above. You should see it in the theme template dropdown. With that done, you can save the changes

Next, navigate to the Theme tab under Online Store and click on the Customize button on the page.

Click on the Home Page dropdown, then on Pages, and then select the template we created.

With that done, hide the content of the page by clicking on the eye icon. After that, click on Add Section, navigate to the Apps tab and then select Customer Portal

With that done, you now have a password-protected page where your customers can manage their subscriptions.

During development, you will be provided with mock data, which will enable you to customize the page's look and feel adequately.

Let's go through the settings and see what you can do with them in the editor. Global Settings: The global settings allow you to customize the background color of the page and also the roundness of the card borders

Font Settings: This is used to set the text color and size.

Button Settings: This is used to customize button text and color.

Product Table Settings: Customize how and if you want to show action add-on products

Card Settings: Customize card box width, border color, and box shadow.

Title Settings: Customize title textx with this setting

With this portal, customers can manage their subscriptions, add products, manage their billing and shipping addresses, manage charges, and also manage payment methods. You can also customize the page using the styles provided. Save the changes and you will have successfully created your customer subscription portal. # Support Should you encounter any challenges or have specific questions, our dedicated support team is here to help. For direct assistance, reach out at . # Theme Extension .Subrise Subscriptions empowers you to personalize the look and feel of your subscriber journey with theme extensions. These are downloadable add-ons that act as design overlays, allowing you to modify the visual appearance of various elements your subscribers interact with. ### Subrise Product Widget The Subrise Product Widget enables easy subscription options for your customers directly where they make their purchase decisions. To install this widget, navigate to the Installation tab on the Settings Page in Subrise.

Click on the Customize Product Widget button.

You will be directed to the customer product page editor where you can choose how you want the page.

Under the Template tab, click the Product Information or Product dropdown click Add Block button. Search for Subrise in the search bar provided and then select Product Page Widget. You should now see the product widget on the editor. Using the editor, you can customize the page's look and feel and then save your changes when you are satisfied. # FAQ ## Subscription Plans ### What are Subscription Plans? Subscription plans are the rules for your subscriptions. Subscription Plans are required to have subscription services in your shop, and we allow for precise customization.

Our Most Common Subscription plan (Subscription Plan) is a monthly charge, monthly delivery

### Whats a Recurring Subscription? This is our most commonly chosen subscription plan, a recurring subscription plan means the billing/deliveries are the same, so the plan might be bill once a month, deliver once a month, or bill every 2 weeks, deliver every 2 weeks, etc. ### What's a Prepaid Recurring Subscription This subscription plan is when a customer pays upfront for a subscription service, but still receives deliveries on a scheduled basis. Even though the customer prepays, this may still be set up as Recurring. (Max Charges > 1) Example: A customer checks out a subscription for 3 Months of Deliveries. They pay for all 3 months at checkout, and receive a delivery every month. But the plan has Max Charges set to "unlimited", which means this customer will be charged for 3 Months of Deliveries again, after the first 3 months have completed. ### What's a One Time Purchase with Multiple Deliveries? (Gifts) This subscription plan is when the a customer pays upfront for a subscription service, but still receives deliveries on scheduled basis. Unlike Prepaid Recurring, this subscription plan terminates after the deliveries have been made. Example: A customer checks out a subscription for 3 Months of Deliveries. They pay for all 3 months at check out, and receive a delivery every month. The plan then terminates (Max Charges are set to 1) ### How Do The Discounts Work? Subrise offers two types of Discounts to a Subscription Plan. Recurring and Fixed. A plan may use one , both, or neither. ### Fixed Discounts

Fixed discounts are discounts that will apply to the products on the subscription the entire time the subscription is active. You may give the products a percent discount, a dollar price discount, or even set the price of items to a specific price. ### Recurring Discounts

The First time the subscription is charged the customer will get 10% off.

Recurring discounts are discounts that are only applied for a set number of charges. In the above example the subscription will only have a 10% discount for one charge. After that charge the subscription will either have no discounts, or will fall back to whatever the fixed discount is.
### What happens if I have Both Discounts Added?

The customer will recieve 20% discount for the first charge, and then 10% for the remaining.

If the merchant has created a plan that utilizes both Recurring Discounts and Fixed Discounts, Recurring discounts will take priority. This means that in this example for the first charge of the subscription, the items will be discounted at 20%, then for the remaining charges on the subscription the will fall back to the Fixed rate of 10%. ### How Do I Add Products to A Subscription Plan? Subrise Subscriptions offer multiple ways to manage your products with your subscriptions

From the Create/Edit Subscription Plan Page, choose the Products Tab

Choose the "Products" tab in the upper right corner of the create/edit Subscription Plan Page. From here the merchant may add any products, or even entire collections to Subscription plans. ### Editing Products & Plans

Click the "Products" page in the Subrise Menu. On this page the merchant has full access to edit all of their products, sell all the plans those products are in, or are not in. The merchant make quickly edit those products here, and even see whom is subscribed to what. ## Prepaid ### How do I create a Prepaid Subscription? A prepaid subscription is when a customer pays upfront at checkout the entire amount of a subscription cost. (Including shipping) In the photo below the customer would receive the monthly deliveries for 3 months, but only billed once at checkout for all 3 months, including shipping. Max Charges is a subscription rule, that states if this prepaid plan will renew, and start over again. If its set to null, in this instance the user will be charged for another 3 months of prepaid subscriptions after they complete the first 3 months of fulfillments.

### What's the difference between One-Time Purchase with Multiple Deliveries (GIFTS) and Prepaid? Gift Subscriptions have a Max Charge that is always set to 1. Meaning after all the products have been delivered the subscription will be over and not auto re-new. The customer will not be charged ever again after checkout. ### How will my customer be charged for Shipping on Prepaid Subscriptions? The customer will be charged upfront for all shipping up front at checkout on prepaid subscriptions, they will not be billed again, unless the prepaid plan is recurring for more than 1 Max Charge. ## Add Ons ### What are Add Ons? Add Ons are products you or your customer may add to a subscription that will only be delivered / charged for 1 or more deliveries.\ \ In the example below a product has been added to the subscription as a Add-On with 1 cycle. This means after this subscription is charged for the month, this product will be charged/delivered, and then removed from the subscription. If the cycle's setting was set to a number > 1, the add-on would stay on the subscription until it had been charged that many times.

Starberry Oregano Starter was added as an Add on to this subscription for 1 cycle.

### How Do I Control What Products I Allow Customers To Add as Add-Ons?

Settings > Customer Portal > Products Allowed For Add Ons

In the Customer Portal Tab, on the Settings page, the Merchant can add products or entire collections of products to give them permission to be added as add-ons by the Customer in the Customer Portal. This allows the merchants to control what products are allowed to have this feature and what are not.

# Getting Started #### Welcome to the Subrise API Documentation Welcome to the Subrise API, the comprehensive gateway for managing and integrating your subscription services. Our API offers a wide array of endpoints designed to streamline the operation of subscriptions, products, subscription plans, customers, and various other functionalities essential for running a successful subscription-based business. This documentation is designed to guide you through the process of leveraging our API to enhance your application or service, providing you with the tools needed to create, manage, and scale your offerings efficiently. **Understanding the API Structure** The Subrise API is structured around several key resources, each catering to different aspects of subscription management: * **Subscriptions**: The core of our service, subscriptions endpoints allow you to create, update, cancel, and retrieve subscription contracts. These endpoints are crucial for managing the lifecycle of your customers' subscriptions. * **Products**: Products are what you offer to your customers. Through the products endpoints, you can list, add, update, and delete products. This allows for a dynamic catalog that can adapt to your evolving business needs. * **Subscription Plans**: These endpoints enable you to define and manage different subscription plans, including pricing, billing cycles, and special offers. Customize plans to cater to a wide range of customer preferences and business strategies. * **Customers**: Customer endpoints are focused on managing customer information, including payment methods, contact details, and subscription history. These endpoints are essential for maintaining a positive customer experience and for operational tasks such as billing and communication. * **Miscellaneous Endpoints**: Beyond the core functionalities, our API provides miscellaneous endpoints that support additional features like reporting, analytics, and webhooks for event-driven actions. These tools offer deeper insights into your subscription metrics and automate workflows for efficiency. **Getting Started** To get started, you'll need an API key, which can be obtained from the Subrise settings page under the API key section. This key must be included in the header of every request you make to authenticate and authorize your access. With comprehensive documentation on each endpoint, including request and response formats, you're equipped to integrate Subrise's capabilities into your application seamlessly. We're here to support your journey in creating an exceptional subscription experience. Whether you're a developer integrating Subrise into your application for the first time or looking to expand your existing offerings, this documentation will serve as your roadmap. If you have any questions or need further assistance, our support team is ready to help. Welcome aboard, and we look forward to seeing how you leverage the Subrise API to grow your subscription business! # Authentication #### Obtaining and Using an API Key from Subrise To securely access and interact with the Subrise API, you'll need to obtain an API key. This key authenticates your requests and ensures that you have permission to retrieve or modify data via the API. Follow the steps below to get started with your API key. **How to Obtain Your API Key** 1. **Sign Up for a Mid-Level Plan**: To access the API key, you must be subscribed to the mid-level plan of Subrise. If you haven't upgraded yet, please visit the Subrise subscription page to select the mid-level plan. 2. **Navigate to the Settings Page**: Once you're on the mid-level plan, log in to your Subrise account. From the dashboard, navigate to the settings page. You can typically find this option in the upper-right corner or in the main navigation menu. 3. **Access the API Key Section**: In the settings menu, look for a section labeled "API Key" or "API Access." Click on this section to view your API key details. 4. **Generate or Copy Your API Key**: If you haven't generated an API key yet, you'll see an option to create one. Follow the prompts to generate your key. If you've already generated a key, you should see it listed on this page. Use the copy function to copy the API key to your clipboard. **Applying Your API Key to Requests** Once you have your API key, you must include it in the header of every request you make to the Subrise API. This is how you authenticate your requests. * **Header Name**: `X-API-KEY` * **Header Value**: Your API key string Here is an example of how to include your API key in a request using `curl`: ```bash curl -X GET "https://api.subrise.com/desired-endpoint" -H "X-API-KEY: YourApiKeyHere" ``` **API Key Scopes** Your API key comes with a specific scope that determines which endpoints you can access. The scopes are: * **Read**: Allows you to retrieve data from the API. You can make GET requests to endpoints that provide information but cannot modify any data. * **Write**: Grants you both read and write access. You can retrieve data as well as make POST, PUT, DELETE, and PATCH requests to modify data. Ensure you're aware of your API key's scope and understand that attempting to perform actions outside of your key's scope will result in an error. **Best Practices for API Key Security** * **Do Not Share Your API Key**: Treat your API key as a sensitive password. Do not share it in publicly accessible areas such GitHub, forums, or websites. * **Limit Access**: Only use your API key in server-side applications or secure environments. Avoid embedding it in client-side code where it can be easily extracted. * **Rotate Keys Regularly**: For added security, regenerate your API keys periodically through the Subrise settings page. By following these guidelines, you can securely access the Subrise API and integrate its capabilities into your applications. If you encounter any issues or have questions about using your API key, please contact Subrise support for assistance. # Subscriptions {% openapi src="/files/hnZ1CYX6mfzteuNLBGei" path="/subscription-contracts/search" method="post" %} [subrise-api-output.yaml](https://1507690303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoNYxxCzbbZsdqiP7Nha8%2Fuploads%2FiN3xVPgWqVhgcwthAiWo%2Fsubrise-api-output.yaml?alt=media\&token=0adc7c51-21ca-46ac-96e9-50745640fcb5) {% endopenapi %} {% openapi src="/files/hnZ1CYX6mfzteuNLBGei" path="/subscriptions/customer-contracts" method="post" %} [subrise-api-output.yaml](https://1507690303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoNYxxCzbbZsdqiP7Nha8%2Fuploads%2FiN3xVPgWqVhgcwthAiWo%2Fsubrise-api-output.yaml?alt=media\&token=0adc7c51-21ca-46ac-96e9-50745640fcb5) {% endopenapi %} {% openapi src="/files/hnZ1CYX6mfzteuNLBGei" path="/subscription-contracts/{contractId}" method="get" %} [subrise-api-output.yaml](https://1507690303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoNYxxCzbbZsdqiP7Nha8%2Fuploads%2FiN3xVPgWqVhgcwthAiWo%2Fsubrise-api-output.yaml?alt=media\&token=0adc7c51-21ca-46ac-96e9-50745640fcb5) {% endopenapi %} # GET {% openapi src="/files/hnZ1CYX6mfzteuNLBGei" path="/subscription-contracts/search" method="post" %} [subrise-api-output.yaml](https://1507690303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoNYxxCzbbZsdqiP7Nha8%2Fuploads%2FiN3xVPgWqVhgcwthAiWo%2Fsubrise-api-output.yaml?alt=media\&token=0adc7c51-21ca-46ac-96e9-50745640fcb5) {% endopenapi %} {% openapi src="/files/hnZ1CYX6mfzteuNLBGei" path="/subscription-contracts/{contractId}" method="get" %} [subrise-api-output.yaml](https://1507690303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoNYxxCzbbZsdqiP7Nha8%2Fuploads%2FiN3xVPgWqVhgcwthAiWo%2Fsubrise-api-output.yaml?alt=media\&token=0adc7c51-21ca-46ac-96e9-50745640fcb5) {% endopenapi %} {% openapi src="/files/hnZ1CYX6mfzteuNLBGei" path="/subscriptions/attempts" method="get" %} [subrise-api-output.yaml](https://1507690303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoNYxxCzbbZsdqiP7Nha8%2Fuploads%2FiN3xVPgWqVhgcwthAiWo%2Fsubrise-api-output.yaml?alt=media\&token=0adc7c51-21ca-46ac-96e9-50745640fcb5) {% endopenapi %} # UPDATE {% openapi src="/files/hnZ1CYX6mfzteuNLBGei" path="/subscriptions/{contractId}/shipping-address" method="put" %} [subrise-api-output.yaml](https://1507690303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoNYxxCzbbZsdqiP7Nha8%2Fuploads%2FiN3xVPgWqVhgcwthAiWo%2Fsubrise-api-output.yaml?alt=media\&token=0adc7c51-21ca-46ac-96e9-50745640fcb5) {% endopenapi %} {% openapi src="/files/hnZ1CYX6mfzteuNLBGei" path="/subscriptions/{contractId}/next-billing-date" method="put" %} [subrise-api-output.yaml](https://1507690303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoNYxxCzbbZsdqiP7Nha8%2Fuploads%2FiN3xVPgWqVhgcwthAiWo%2Fsubrise-api-output.yaml?alt=media\&token=0adc7c51-21ca-46ac-96e9-50745640fcb5) {% endopenapi %} {% openapi src="/files/hnZ1CYX6mfzteuNLBGei" path="/subscriptions/skip/{contractId}/next-billing-date" method="put" %} [subrise-api-output.yaml](https://1507690303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoNYxxCzbbZsdqiP7Nha8%2Fuploads%2FiN3xVPgWqVhgcwthAiWo%2Fsubrise-api-output.yaml?alt=media\&token=0adc7c51-21ca-46ac-96e9-50745640fcb5) {% endopenapi %} {% openapi src="/files/hnZ1CYX6mfzteuNLBGei" path="/subscriptions/{contractId}/line-item" method="put" %} [subrise-api-output.yaml](https://1507690303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoNYxxCzbbZsdqiP7Nha8%2Fuploads%2FiN3xVPgWqVhgcwthAiWo%2Fsubrise-api-output.yaml?alt=media\&token=0adc7c51-21ca-46ac-96e9-50745640fcb5) {% endopenapi %} {% openapi src="/files/hnZ1CYX6mfzteuNLBGei" path="/subscriptions/{contractId}/add-line-item" method="put" %} [subrise-api-output.yaml](https://1507690303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoNYxxCzbbZsdqiP7Nha8%2Fuploads%2FiN3xVPgWqVhgcwthAiWo%2Fsubrise-api-output.yaml?alt=media\&token=0adc7c51-21ca-46ac-96e9-50745640fcb5) {% endopenapi %} {% openapi src="/files/hnZ1CYX6mfzteuNLBGei" path="/subscriptions/{contractId}/add-addon-line-item" method="put" %} [subrise-api-output.yaml](https://1507690303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoNYxxCzbbZsdqiP7Nha8%2Fuploads%2FiN3xVPgWqVhgcwthAiWo%2Fsubrise-api-output.yaml?alt=media\&token=0adc7c51-21ca-46ac-96e9-50745640fcb5) {% endopenapi %} {% openapi src="/files/hnZ1CYX6mfzteuNLBGei" path="/subscriptions/{contractId}/remove-add-on" method="put" %} [subrise-api-output.yaml](https://1507690303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoNYxxCzbbZsdqiP7Nha8%2Fuploads%2FiN3xVPgWqVhgcwthAiWo%2Fsubrise-api-output.yaml?alt=media\&token=0adc7c51-21ca-46ac-96e9-50745640fcb5) {% endopenapi %} {% openapi src="/files/hnZ1CYX6mfzteuNLBGei" path="/subscriptions/{contractId}/pause" method="put" %} [subrise-api-output.yaml](https://1507690303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoNYxxCzbbZsdqiP7Nha8%2Fuploads%2FiN3xVPgWqVhgcwthAiWo%2Fsubrise-api-output.yaml?alt=media\&token=0adc7c51-21ca-46ac-96e9-50745640fcb5) {% endopenapi %} # DELETE {% openapi src="/files/hnZ1CYX6mfzteuNLBGei" path="/subscriptions/{contractId}" method="delete" %} [subrise-api-output.yaml](https://1507690303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoNYxxCzbbZsdqiP7Nha8%2Fuploads%2FiN3xVPgWqVhgcwthAiWo%2Fsubrise-api-output.yaml?alt=media\&token=0adc7c51-21ca-46ac-96e9-50745640fcb5) {% endopenapi %} # Products {% openapi src="/files/hnZ1CYX6mfzteuNLBGei" path="/subscriptions/allProducts" method="get" %} [subrise-api-output.yaml](https://1507690303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoNYxxCzbbZsdqiP7Nha8%2Fuploads%2FiN3xVPgWqVhgcwthAiWo%2Fsubrise-api-output.yaml?alt=media\&token=0adc7c51-21ca-46ac-96e9-50745640fcb5) {% endopenapi %} {% openapi src="/files/hnZ1CYX6mfzteuNLBGei" path="/subscriptions/variants/{productId}" method="get" %} [subrise-api-output.yaml](https://1507690303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoNYxxCzbbZsdqiP7Nha8%2Fuploads%2FiN3xVPgWqVhgcwthAiWo%2Fsubrise-api-output.yaml?alt=media\&token=0adc7c51-21ca-46ac-96e9-50745640fcb5) {% endopenapi %} # Subscription Plans {% openapi src="/files/hnZ1CYX6mfzteuNLBGei" path="/selling-plan-groups" method="get" %} [subrise-api-output.yaml](https://1507690303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoNYxxCzbbZsdqiP7Nha8%2Fuploads%2FiN3xVPgWqVhgcwthAiWo%2Fsubrise-api-output.yaml?alt=media\&token=0adc7c51-21ca-46ac-96e9-50745640fcb5) {% endopenapi %} {% openapi src="/files/hnZ1CYX6mfzteuNLBGei" path="/selling-plan-groups/{sellingPlanGroupId}" method="get" %} [subrise-api-output.yaml](https://1507690303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoNYxxCzbbZsdqiP7Nha8%2Fuploads%2FiN3xVPgWqVhgcwthAiWo%2Fsubrise-api-output.yaml?alt=media\&token=0adc7c51-21ca-46ac-96e9-50745640fcb5) {% endopenapi %} {% openapi src="/files/hnZ1CYX6mfzteuNLBGei" path="/selling-plan-groups/{sellingPlanGroupId}/products" method="get" %} [subrise-api-output.yaml](https://1507690303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoNYxxCzbbZsdqiP7Nha8%2Fuploads%2FiN3xVPgWqVhgcwthAiWo%2Fsubrise-api-output.yaml?alt=media\&token=0adc7c51-21ca-46ac-96e9-50745640fcb5) {% endopenapi %} # Customers {% openapi src="/files/hnZ1CYX6mfzteuNLBGei" path="/payment-methods/customer-payment-methods" method="get" %} [subrise-api-output.yaml](https://1507690303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoNYxxCzbbZsdqiP7Nha8%2Fuploads%2FiN3xVPgWqVhgcwthAiWo%2Fsubrise-api-output.yaml?alt=media\&token=0adc7c51-21ca-46ac-96e9-50745640fcb5) {% endopenapi %} {% openapi src="/files/hnZ1CYX6mfzteuNLBGei" path="/payment-methods/{paymentMethodId}" method="delete" %} [subrise-api-output.yaml](https://1507690303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoNYxxCzbbZsdqiP7Nha8%2Fuploads%2FiN3xVPgWqVhgcwthAiWo%2Fsubrise-api-output.yaml?alt=media\&token=0adc7c51-21ca-46ac-96e9-50745640fcb5) {% endopenapi %} # Fields & Events {% openapi src="/files/hnZ1CYX6mfzteuNLBGei" path="/event-log/" method="get" %} [subrise-api-output.yaml](https://1507690303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoNYxxCzbbZsdqiP7Nha8%2Fuploads%2FiN3xVPgWqVhgcwthAiWo%2Fsubrise-api-output.yaml?alt=media\&token=0adc7c51-21ca-46ac-96e9-50745640fcb5) {% endopenapi %} {% openapi src="/files/hnZ1CYX6mfzteuNLBGei" path="/fields/" method="get" %} [subrise-api-output.yaml](https://1507690303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoNYxxCzbbZsdqiP7Nha8%2Fuploads%2FiN3xVPgWqVhgcwthAiWo%2Fsubrise-api-output.yaml?alt=media\&token=0adc7c51-21ca-46ac-96e9-50745640fcb5) {% endopenapi %}