Setting modules for merchant plans
Each Clover merchant subscribes to a software as a service (SaaS) plan as per their business needs. These SaaS plans provide merchants with access to specific modules. Modules are categories of functionality available in each merchant SaaS plan on the Clover platform.
Modules do not limit the use of any API endpoint. Clover 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 with order handling capabilities.
Merchant SaaS plans
Merchant SaaS plans are tiered:
- Entry-level plans provide access to a limited set of modules, such as Payments/Payments Plus reach most merchants but support only basic features.
- Full-featured or higher-level 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, then 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 and Canada merchant SaaS plans
NOTE
The plans — 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 and 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 | 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 |
European Union (EU) merchant SaaS plans
IMPORTANT
The US Register and Counter-Service plans are combined in the EU as the Classic Merchants and Register Merchants plan.
| Plan | Description | Supported devices |
|---|---|---|
| Payments Plus | Entry-level plan for smart, cloud-based payments, employee and customer management | Clover Mini, Flex + Clover apps that do not require order or item-level data |
| Register Lite | Cash register replacement with simple inventory and 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 and table-side ordering, firing, and 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 |
Identify 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 | CO_TERMINAL | PAYMENTS |
| Payments Plus | CO_TERMINAL | PAYMENTS_PLUS |
| Essentials | CO_REGISTER_LITE | REGISTER_LITE |
| Register Lite | CO_REGISTER_LITE | REGISTER_LITE |
| Register | CO_REGISTER | REGISTER |
| Counter-Service | CO_REGISTER | COUNTER_SERVICE_RESTAURANT |
| Table-Service | CO_REGISTER | TABLE_SERVICE_RESTAURANT |
Add modules for your app
Clover recommends you select only the modules that apply to your app. For example:
- Entry or 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.
If your app applies discounts to orders based on added items, you require the Orders, Items, and Discounts modules. In the US, your app is available to all merchant SaaS plans, except the Payments Plus plan.
To add modules for your app:
- Log in to the Developer Dashboard.
- From the left-navigation menu, select App Settings. The App Settings page appears.
- Click Merchant Availability. The Edit Merchant Availability page appears.
- Select the required modules for your app.
- Click Save. The selected modules are available for your app to test with your test merchants.
NOTE
Your apps must not expose module functionality of the SaaS plans to which the merchants have not subscribed. For example, do not expose any Items module features to Payments Plus merchants who cannot create and edit items.
Updated 3 months ago