Platform Docs

Setting up modules & merchant plans

Modules represent categories of the functionality available on the Clover platform.

When you plan your app, you can add metadata about your app's functionality using the Clover modules framework. For example, an app that works with Orders is useful to those merchants that have order handling capabilities within the platform.

Clover collects this information to help pair merchants with features that developers implement. This helps Clover target apps to the right set of merchants.

IMPORTANT

Merchants can purchase or install an app only if their merchant plan has all the modules selected by your app. Hence, select only those modules that your app requires at a minimum to function properly and ensure that most merchants can purchase and install your app.

Check merchant module

Your app must check the modules a merchant has enabled using the v3/merchants/mid REST endpoint, or using the clover-android-sdk using the v1 MerchantConnector to get the modules from the merchant object. Use the merchantPlan.planCode value to identify the plan that your merchant is on using the Merchants API endpoint.

Modules don't affect which Clover APIs are used, but your apps shouldn't expose module functionality that should be hidden for certain merchants. For example, an app available to merchants without the 'Items' module must not expose functionality allowing a merchant to create and edit items or create orders with items.

Merchant plans

Clover offers four service plans for merchants.

Payments Plus
Register Lite
Register
Table Service (EU)

Entry-level Clover software plan providing cloud backup and real-time, remote monitoring

Cash register replacement with simple inventory and order management

Complete POS experience with enhanced inventory and order management

Complete POS experience with enhanced inventory and order management

Clover Mini, Clover Flex, Clover Mobile, + Clover apps that do not require order or item-level data

Clover Mini, Clover Flex, Clover Mobile, tethered Clover Mini-to-Clover Mini, + Clover apps that integrate with order and item-level data

Clover Station with tethered-Clover Mini, Clover Mobile or Clover Flex, Clover Mini, kitchen printer, weight scales + Clover apps that integrate with order and item-level data

Clover Station with tethered-Clover Mini (UK/IE only), Clover Flex, Clover Mini, kitchen printer, weight scales + Clover apps that integrate with order and item-level data

Merchant plan
Value

Register/Table Service

CO_REGISTER

Register Lite

CO_REGISTER_LITE

Payments Plus

CO_TERMINAL

The following table shows the modules for each Clover merchant plan:

NOTE

The Register Lite plan is currently not supported in Quebec.

Payments Plus
Register Lite
Register
Table Service

Availability

US, EU, Canada

US, EU, Canada (except Quebec)

US, EU

EU

Payments - accepts all forms

:white-check-mark+:

:white-check-mark+:

:white-check-mark+:

:white-check-mark+:

Employee management

:white-check-mark+:

:white-check-mark+:

:white-check-mark+:

:white-check-mark+:

Customer engagement

:white-check-mark+:

:white-check-mark+:

:white-check-mark+:

:white-check-mark+:

Inventory management

:white-check-mark+:
Basic
Simple items
Stock tracking

:white-check-mark+:
Enhanced
Items with modifiers and variants
Track cost

:white-check-mark+:
Enhanced
Items with modifiers and variants
Track cost

Order management

:white-check-mark+:
Basic
Create, save, and refund orders
Item categories

:white-check-mark+:
Enhanced
Order types
Combine multiple orders

:white-check-mark+:
Enhanced
Order types
Combine multiple orders

Additional features

Open tabs
Discount-based rewards
Limited access to Clover App Market

All features of Payments Plus, plus:
Connect to customer facing display (tethering)
Item level discounts
Item level tax calculations
Item level rewards
Full access to Clover App Market

All additional features for Payments Plus and Register Lite, plus:
Remote order (kitchen) printing
Kitchen order display
Support for larger 11.6" touch screen
Weight scale support
Full access to Clover App Market

All additional features for Payments Plus and Register Lite, plus:
Table mapping layout
Remote order (kitchen) printing
Kitchen order display
Support for larger 11.6" touch screen
Weight scale support
Full access to Clover App Market

NOTE

Clover merchants in Canada have access to only the Payments Plus service plan. Please keep this in mind when you are building your app for the Clover App Market in Canada.

Example

What modules does your app need to function? If your app applies discounts to orders based on added items, you would require the Orders, Items, and Discounts modules.

In this case, your app would be available to Register Lite merchants, Classic merchants, Register merchants, and Table Service merchants, but not to Payments Plus merchants.

  1. On the Developer Dashboard, click App Settings on the side-nav.
  2. On the App Settings page, click Merchant Availability.
  3. On the Edit Merchant Availability modal that appears, select the required modules for your app.
  4. Click Save. The selected modules are now available for your app to test with your test merchants.

NOTE

Lower-level plans such as Payments Plus reach the most merchants but support only basic features. Higher-level plans such as Register-specific plans allow for richer functionality but reduce the number of merchants your app will reach.

We recommend that you select only those modules that apply to your app.

Module
Payments Plus
Register Lite
Register/Table Service

Payments

:white-check-mark+:

:white-check-mark+:

:white-check-mark+:

Employees

:white-check-mark+:

:white-check-mark+:

:white-check-mark+:

Settings

:white-check-mark+:

:white-check-mark+:

:white-check-mark+:

Printers

:white-check-mark+:

:white-check-mark+:

:white-check-mark+:

Customers

:white-check-mark+:

:white-check-mark+:

:white-check-mark+:

Orders

:white-check-mark+:

:white-check-mark+:

Items

:white-check-mark+:

:white-check-mark+:

Discounts

:white-check-mark+:

:white-check-mark+:

Cash

:white-check-mark+:

:white-check-mark+:

Tax Rates

:white-check-mark+:

:white-check-mark+:

Customer Preferences & Promotions

:white-check-mark+:

:white-check-mark+:

Order Types

:white-check-mark+:

Order Printers

:white-check-mark+:

Item Modifiers

:white-check-mark+:

Service Charges

:white-check-mark+:

Combine & Assign Orders

:white-check-mark+:

Automatic Discounts

:white-check-mark+:

Weight Per-Unit Items

:white-check-mark+:

Item Variants

:white-check-mark+:

Table Management

:white-check-mark+:

Item Exchanges

:white-check-mark+:

Bar Tab Management

:white-check-mark+:

Restaurant Shift Management

:white-check-mark+:

Updated about a month ago


Setting up modules & merchant plans


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.