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 targeting 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, 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 plan merchants, select Payments 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
NOTE
The plan names Payments Plus and Register Lite may be called Payments and Essentials respectively, depending on the channel and region.
Plan | Description | Supported devices |
|---|---|---|
Payments/Payments Plus | Entry-level plan for smart, cloud-based payments, employee & customer management | Clover Mini, Flex, Mobile, or no device, + Clover apps that do not require order or item-level data |
Essentials/Register Lite | Cash register replacement with simple inventory & order management + all Payments features | Clover Mini, Flex, Mobile, tethered Mini-to-Mini, or no device, + Clover apps that integrate with order & item-level data |
Register | Full-featured POS with enhanced inventory & order management, including modifiers, modifier groups, and variants + all Payments Plus & Register Lite features | Clover Station Duo (formerly Station Pro); Station Solo; 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 | Full-featured POS for counter-service restaurants with tools including item modifiers, modifier groups, variants, bar tabs, & menu management | Clover Station Duo (formerly Station Pro), Station Solo, Station 2018 (US), Mini, Flex, Mobile (US), tethered Station-to-Mini, Flex, or Mobile (US); kitchen printer; weight scales + Clover apps that integrate with order & item-level data |
Table-Service (excluding Quebec) | Full-featured POS for table-service restaurants with tools including table mapping & table-side ordering, firing, modifiers, modifier groups, variants, & payments | Clover Station Duo (formerly Station Pro), Station Solo, Station 2018 (US), Mini, Flex, Mobile (US), tethered Station-to-Mini, Flex, or Mobile (US); 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.
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 Duo (formerly 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 Duo (formerly 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=merchantPlanREST endpointMerchantConnectorin the Clover Android SDK
The planCode and type values provide merchant plan information.
Merchant plan | Plan code | Type |
|---|---|---|
Payments |
|
|
Payments Plus |
|
|
Essentials |
|
|
Register Lite |
|
|
Register |
|
|
Counter-Service |
|
|
Table-Service |
|
|
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.
- On the Developer Dashboard, click App Settings on the side-nav.
- On the App Settings page, click Merchant Availability.
- On the Edit Merchant Availability modal that appears, select the required modules for your app.
- Click Save. The selected modules are now available for your app to test with your test merchants.
Lower-level plans such as Payments/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 5 months ago