Skip to content

Commit

Permalink
Merge branch 'main' of github.com:SchematicHQ/schematic-fern-config
Browse files Browse the repository at this point in the history
  • Loading branch information
bpapillon committed Jan 20, 2025
2 parents 4bf5359 + 73afb86 commit 1ca7849
Show file tree
Hide file tree
Showing 6 changed files with 98 additions and 3 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion fern/docs/pages/api_documentation/resources.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ API keys allows you to create and manage API keys across environments.

## Environments

Environments typically represent the stages of your software development lifecylce (common environments include development, staging, and production). With this resource, you can create and manage environments. [Some objects](/api-reference/developer_resources/environments) are shared across environments.
Environments typically represent the stages of your software development lifecylce (common environments include development, staging, and production). With this resource, you can create and manage environments. [Some objects](/developer_resources/environments) are shared across environments.
- [POST /environments](/api-reference/accounts/create-environment)
- [PUT /environments/`{environment_id}`](/api-reference/accounts/update-environment)
- [DEL /environments/`{environment_id}`](/api-reference/accounts/delete-environment)
Expand Down
14 changes: 13 additions & 1 deletion fern/docs/pages/catalog/management.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ If you've integrated Stripe, Schematic offers several ways to handle plan change

You can manage a company's plan directly on the company profile page in Scehmatic. These changes automatically sync with Stripe to update a company's subscsription.

<Info>You currently are not able to move a company from a Stripe-associated plan to a plan that is not associated with a Stripe product.</Info>

<img
src="../../assets/images/catalog/management-manage-plan.png"
/>
Expand All @@ -67,7 +69,17 @@ If you prefer to make changes directly in Stripe, Schematic will automatically s

### Not using Stripe

If you’re not using Stripe or are otherwise using plan audiences, there are a couple of options.
If you’re not using Stripe or are otherwise using plan audiences, there are a few options.

**On the company profile page in Schematic**

You can manage a company's plan directly on the company profile page in Scehmatic.

<Info>You currently are not able to move a company from a plan that is not associated with a Stripe product to a Stripe-associated plan.</Info>

<img
src="../../assets/images/catalog/management-manage-plan-nonstripe.png"
/>

**Explicit company assignment using plan audience rules**

Expand Down
4 changes: 3 additions & 1 deletion fern/docs/pages/catalog/trials.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,6 @@ You can configure whether payment is required up front or not in the Catalog con

<img
src="../../assets/images/catalog/catalog-plans-trial.png"
/>
/>

<Info>If you change trial configuration (e.g. whether a trial is a part of a plan, credit card requirement), any companies currently in a trial will be unaffected, and the new setting will apply going forward.</Info>
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: Components Overview

slug: components/overview
---

Schematic’s embeddable UI components are designed to deliver a consumer-grade purchasing experience to all of your end users. That includes the ability to manage subscriptions, view feature-level usage, and customize plans in your app — all without requiring heavy lifting to build from scratch or maintain.

Components are drop-in components for React that can be easily configured and designed within Schematic, and quickly integrated natively into your application.

## Creating a Component

### **Configuring the Catalog**

1. Navigate to **Catalog > Configuration**
2. Choose a default plan that all companies will be assigned if there is no formal subscription (optional)
3. Choose “live plans” (those that your end users can choose to downgrade from or upgrade to)
4. Save changes

<Info>Plans must be associated with Stripe Products to be added to Live Plans. If you don’t use Stripe, skip this section.</Info>

<img
src="../../assets/images/components/components-plan-configuration.png"
/>

### **Creating a new UI component**

Once you’ve configured your Catalog, Components will be populated with your data rather than sample data (if you skip to this section, you can simply use the sample data).

1. Navigate to **Components** in the navigation bar
2. Click **New Component** and choose “Customer Portal” as an example
3. Click into the new Component you created and you should see a rendered customer portal in the Schematic Component Builder
4. Press **Save & Publish** and follow the [steps to drop into your application](/components/set-up)

<img
src="../../assets/images/components/components-builder.png"
/>

Components are fully customizable both in the elements they are made up of (e.g. Current Plan, Included Features, Invoices, etc.) and in how they look and feel (so it appears native to your product).

Additionally, you may preview as any company in your account using the dropdown at the top of the builder.

<img
src="../../assets/images/components/components-builder-preview.png"
/>


## Component Builder

Components are inherently flexible, made up of [elements](/components/element-library) that can be mixed and matched based on the experience you’d like to give your end user.

Within Schematic, you have access to a Component Builder which allows for full customization both in the elements that are a part of any given Component (e.g. Current Plan, Included Features, Invoices, etc.) and in how the Component looks and feels (so it appears native to your product).

Once you design a Component to your liking, you can drop it directly into your application.
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: Feature Management Overview

slug: feature_management/overview
---

Feature Management in Schematic enables you to control how product features are rolled out, accessed by end customers, and monetized. Unlike traditional feature management tools, Schematic is purpose-built with billing in mind, so feature access can be tied directly to a company’s plan and any other policy set up in Schematic (e.g. add ons, overrides, or individual targeting).

Flags and Features are technically different concepts in Schematic:
- **Flags** - represent the gate that you implement in your codebase to control whether or not a resource is accessible to the end user.
- **Features** - represent an abstraction on top of flags that the business may market or sell.

<img
src="../../assets/images/features/features-homepage.png"
/>

## Use cases
- **Rollout new features**: Rollout gradually to a small cohort to mitigate risk or to gather feedback.
- **Line up access with subscriptions**: Ensure customers only see features tied to their subscription plans or usage limits.
- **Manage exceptions**: Selectively enable or disable features for individual customers.
- **Drive upgrades and renewals**: Enable feature trials or time-limited overrides.
- **Simplify billing implementation**: Eliminate the need for custom code by linking feature flags directly to billing.

## How can teams use Schematic feature management
- **Engineers**: Replace homegrown feature flag or metering logic and get an out of the box admin panel to manage them.
- **Product Managers**: Get fine-grained control over how much and which features are available to different customer segments.
- **GTM Teams**: Grant plan and feature trials to close deals and drive upsell.

0 comments on commit 1ca7849

Please sign in to comment.