Platform Docs

Setting modules for merchant plans

Depending on their business needs, every Clover merchant subscribes to a SaaS plan, which provides merchants with access to specific modules. Modules represent categories of functionality available in each merchant SaaS plan on the Clover platform.

Modules do not limit the use of any API endpoint. Clover simply uses modules for targetting apps to the right set of merchants based on their SaaS plans. For example, an app for managing merchant orders is targeted to merchants with SaaS plans that have order handling capabilities.

Merchant SaaS plans

Merchant SaaS plans are tiered. Entry-level plans, such as Payments Plus, provide access to a limited set of modules. Full-featured plans provide access to premium modules in addition to all the entry-level plan modules.

🚧

IMPORTANT

A merchant can purchase or install your app if the app functions with any of the modules listed in the merchant's SaaS plan. More merchants can purchase and install your app if you select only the minimum set of modules that your app requires to function properly.

For example, if your app is built for Register plan merchants and a smaller subset of features are also available to entry-level Payments Plus plan merchants, select Payments Plus modules for your app.

List of merchant SaaS plans

Clover merchants can subscribe to a merchant SaaS plan based on their business requirements.

US & Canada merchant SaaS plans

📘

IMPORTANT

Clover merchants in Canada have access to only the Payments Plus and Register Lite plans. Please keep this in mind when you are building apps for the Clover App Market in Canada.

Plan

Description

Supported devices

Payments Plus

Entry-level plan for smart, cloud-based payments, employee & customer management

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

Register Lite

Cash register replacement with simple inventory & order management + all Payments Plus features

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

Register (US only)

Full-featured POS with enhanced inventory & order management + all Payments Plus & Register Lite features

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

Counter-Service (US only)

Full-featured POS for counter service restaurants with tools including item modifiers, bar tabs, & menu management

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

Table-Service (US only)

Full-featured POS for table service restaurants with tools including table mapping & table-side ordering, firing, & payments

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

EU merchant SaaS plans

🚧

IMPORTANT

The US Register and Counter-Service plans are combined in the EU as the Classic Merchants & Register Merchants plan.

Plan

Description

Supported devices

Payments Plus

Entry-level plan for smart, cloud-based payments, employee & customer management

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

Register Lite

Cash register replacement with simple inventory & order management + all Payments Plus features

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

Classic Merchants & Register Merchants

Full-featured POS with enhanced inventory and order management, including features for counter service restaurants + all Payments Plus & Register Lite features

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

Table-Service

Full-featured POS for table service restaurants with tools including table mapping & table-side ordering, firing, & payments

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

Identifying a merchant's SaaS plan

Your app can identify a merchant's merchant plans and modules using:

  • v3/merchants/{mId}?expand=merchantPlan REST endpoint
  • MerchantConnector in the Clover Android SDK

The planCode and type values provide merchant plan information.

Merchant plan

Plan code

Type

Payments Plus

CO_TERMINAL

PAYMENTS_PLUS

Register Lite

CO_REGISTER_LITE

REGISTER_LITE

Register

CO_REGISTER

REGISTER

Counter-Service (US only)

CO_REGISTER

QSR

Table-Service

CO_REGISTER

DINING

Adding modules for your app

If your app applies discounts to orders based on added items, you would require the Orders, Items, and Discounts modules. In the US, your app will be available to all merchant SaaS plans except the Payments Plus plan.

  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.

Lower-level plans such as Payments Plus reach 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.

📘

NOTE

Your apps must not expose module functionality to merchants on SaaS plans that do not have access to that module. For example, do not expose any Items module features to Payments Plus merchants who cannot create and edit items.

Updated 2 months ago


Setting modules for 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.