Skip to main content

Mantle

Mantle (heymantle.com) is a subscription billing and loyalty infrastructure platform for Shopify apps. It tracks customer subscriptions, usage-based billing events, invoices, and identify calls, giving app developers a unified API for pricing, plans, and revenue operations. The Nexla connector uses Mantle's App API to read billing data into Nexla and to push customer, subscription, and usage records back into Mantle.

Mantle icon

Power end-to-end data operations for your Mantle API with Nexla. Our bi-directional Mantle connector is purpose-built for Mantle, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Mantle or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Mantle workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Mantle credential, you need a Mantle App API key. Mantle authenticates App API requests with an API key passed as a Bearer token in the Authorization header (Authorization: Bearer <api_key>).

To obtain your Mantle App API key, follow these steps:

  1. Sign in to your Mantle account at heymantle.com and select the app you want to integrate.

  2. Open your app's Settings and locate the API Keys section.

  3. Create a new API key scoped to the permissions your integration needs, and copy the generated key. Store it securely, as it grants administrative access to your app's billing and customer data.

Mantle App API keys are administrative credentials. Never expose an App API key in frontend or browser-facing code, and do not commit it to source control. For customer-facing requests, Mantle recommends using the customer API token returned from an identify call instead.

For complete details on generating credentials and authenticating requests, see the Mantle documentation.

Authenticate

Credentials required

FieldRequiredSecretDescription
API KeyYesYesMantle API key used for Bearer authentication.

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter your Mantle App API key in the API Key field. Nexla sends this value as a Bearer token in the Authorization header on every request to the Mantle API, so it must be kept confidential.

  4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Mantle connector tile, then select the credential that will be used to connect to Mantle, and click Next; or, create a new Mantle credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Mantle endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

List Subscriptions

This endpoint template retrieves subscriptions from your Mantle app. Use it to bring subscription records into Nexla for reporting, revenue analysis, or downstream integration.

  • This endpoint pages through results automatically using Mantle's cursor-based pagination, so Nexla fetches all available subscription records without additional configuration.

List Customers

This endpoint template retrieves customers from your Mantle app. Use it to bring customer records into Nexla for analytics, segmentation, or synchronization with other systems.

  • This endpoint pages through results automatically using Mantle's cursor-based pagination, so Nexla fetches all available customer records without additional configuration.

Get Customer

This endpoint template retrieves a single customer's full record, including plans, subscription, payment method, invoices, and usage credits. Use it when you need the complete billing profile for one customer.

  • Configure the following parameter for this endpoint:

    • Customer ID (required): The Mantle customer ID, Shopify domain, or API token identifying the customer to retrieve.

List Usage Events

This endpoint template retrieves a list of usage events for a customer. Use it to ingest usage-based billing activity into Nexla for metering, reconciliation, or reporting.

  • Configure the following parameters for this endpoint:

    • Customer ID (required): The customer identifier to scope usage events to.
    • Page (optional): The page number to fetch. Defaults to 0.
    • Page Size (optional): The number of records to fetch per page. Defaults to 25.
  • This endpoint pages through results automatically using Mantle's incrementing page pagination.

Get Usage Events Report

This endpoint template retrieves aggregated usage metrics (count, sum, or unique) for a customer's event over a period. Use it when you need summarized usage totals rather than individual events.

  • Configure the following parameters for this endpoint:

    • Customer ID (required): The customer identifier to scope the report to.
    • Event Name (required): The usage event name to aggregate.

List Invoices

This endpoint template retrieves invoices for a customer. Use it to bring billing history into Nexla for financial reporting or reconciliation.

  • Configure the following parameters for this endpoint:

    • Page (optional): The page number to fetch. Defaults to 1.
    • Page Size (optional): The number of records to fetch per page. Defaults to 25.
  • This endpoint pages through results automatically using Mantle's incrementing page pagination.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Mantle data sources can also be manually configured to ingest data from any valid Mantle API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Mantle data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Mantle destination, and select the Send to Destination option from the menu. Select the Mantle connector from the list of available destination connectors, then select the credential that will be used to connect to Mantle, and click Next; or, create a new Mantle credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Mantle endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Identify Customer

This endpoint template identifies or upserts a customer in Mantle using records from a Nexset. Use it to sync customer records from your Nexla flows into Mantle.

  • Each record from your Nexset is sent as a JSON request body to create or update the corresponding customer in Mantle.

Track Usage Event

This endpoint template tracks a customer app usage event in Mantle. Use it to send usage-based billing events from your Nexla flows into Mantle for metering.

  • Each record from your Nexset is sent as a JSON request body representing a single usage event.

Create Subscription

This endpoint template subscribes a customer to a plan in Mantle. Use it to automate subscription creation from your Nexla flows.

  • Each record from your Nexset is sent as a JSON request body describing the customer and the plan to subscribe them to.

Cancel Subscription

This endpoint template unsubscribes a customer from a plan in Mantle. Use it to automate subscription cancellations from your Nexla flows.

  • Each record from your Nexset is sent as a JSON request body identifying the subscription to cancel.

Create One-Time Charge

This endpoint template creates a one-time charge for a customer in Mantle. Use it to bill customers for one-off items from your Nexla flows.

  • Each record from your Nexset is sent as a JSON request body describing the customer and the charge to apply.

Apply Subscription Discount

This endpoint template applies a discount to an existing subscription in Mantle. Use it to automate promotional or retention discounts from your Nexla flows.

  • Configure the following parameter for this endpoint:

    • Subscription ID (required): The subscription to apply the discount to.
  • Each record from your Nexset is sent as a JSON request body describing the discount to apply.

Create Usage Credit

This endpoint template applies usage credits to a customer's account in Mantle. Use it to grant credits programmatically from your Nexla flows.

  • Each record from your Nexset is sent as a JSON request body describing the customer and the credits to apply.

Apply Discount Code

This endpoint template validates and applies a discount code in Mantle. Use it to redeem promotional codes from your Nexla flows.

  • Each record from your Nexset is sent as a JSON request body containing the discount code to validate and apply.

Create Payment Method

This endpoint template creates a Stripe-backed payment method for a customer in Mantle. Use it to attach payment methods to customers from your Nexla flows.

  • Each record from your Nexset is sent as a JSON request body describing the customer and the payment method to create.

Create Hosted Session

This endpoint template creates a hosted checkout or account-management session URL for a customer in Mantle. Use it to generate hosted session links from your Nexla flows.

  • Each record from your Nexset is sent as a JSON request body describing the customer and the session to create.

Manual configuration

Mantle destinations can also be manually configured to send data to any valid Mantle API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Mantle APIs expect JSON format for write operations. For endpoints that target a specific resource, include the resource identifier in the endpoint URL as required by the Mantle API.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Mantle endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Mantle endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.