Surfacing Mantle data

Mantle can automatically surface important information about the currently authenticated customer such as:

Plans that are available for the customer to subscribe to
Details about the customer’s active subscription, such as its trial status and trial information
Usage metrics that the customer has accumulated over the current billing period

To help you get started, Mantle currently provides a number of open source packages via NPM:

Mantle JS client - a simple JS client that can be used to interact with the Mantle API from both the frontend and backend
React SDK - this package provides a React context provider and hook which expose data surfaced by the client in an easy to consume way
Polaris 12 components package for those who are striving to attain “Built for Shopify” status

MantleClient

Our JavaScript client wrapper which can be used to make network requests to the REST API.

MantleProvider

Our React Context API implementation to expose the Mantle JavaScript client to your web application.

useMantle() hook

A simple React hook which can be used to access the context of the MantleProvider.

Use with Shopify App Bridge

Learn how to integrate Mantle with Shopify App Bridge for performing external redirects and enhancing your app's functionality.

Feature usage

Determine how much of a specific feature has been used

Plans components

Drop-in React components to display the list of available plans to your users

Changelogs

An API to fetch the changelogs you've created in Mantle and display on your own website.