Each Clover merchant subscribes to a software as a service (SaaS) or service plan as per their business needs. These service plans provide merchants access to specific modules. For more pricing and plans, see Clover Pricing.

What are modules?

Modules are categories of functionality available in each merchant service 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 service plans. For example, an app for managing merchant orders is for merchants with service plans with order handling capabilities. See Add plan-based modules for your app.

Merchant service plan tiers and modules

Merchant service plans are tiered:

• Entry-level plans provide access to limited modules, such as Payments or Payments Plus, that reach most merchants but support only basic features.
• Full-featured or higher-level plans provide access to premium modules and all the entry-level plan modules.

👍

TIP

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

Region-based merchant service plans

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

United States and Canada merchant service plans

📘

NOTE

Depending on the channel and region, Payments Plus may be called Payments and and Register Lite may be referred to as Essentials.

Europe merchant service plans

Latin America merchant service plans

Identify a merchant's service plan

Your app can identify a merchant's service plans and modules with the following:

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

The planCode and type values provide merchant plan information.

Add plan-based modules for your app

You can select functionality modules for your app based on the service plans. See Merchant service plan tiers and modules. Clover recommends you select only the modules that apply to your app. For example, if your app applies discounts to orders based on added items, you require the Orders, Items, and Discounts modules.

Merchant plans and corresponding modules are available for your app based on regions. In the United States (US), your app is available to all merchant service plans except the Payments Plus plan. See Region-based merchant service plans.

When adding modules to a plan, note the following:

• If the merchant's subscribe service plan does not have a module required for an app, they cannot install or connect to the app.
• If a merchant's service plan changes and a module required for an app is removed, the app is uninstalled from their system.
• Your apps must not display the module functionality of the plans the merchants have not subscribed to. For example, do not display the Items module features to Payments Plus merchants who cannot create and edit items.

To add modules for your app:

1. Log in to the sandbox Developer Dashboard.
2. From the left navigation menu, click an app that displays under Your Apps.

3. Click App Settings. The App Settings page appears.
4. Click Merchant Availability. The Edit Merchant Availability page displays plans and corresponding modules based on the region in which your app is available.

5. For a merchant service plan, select the checkbox for the modules you want to make available to your merchants.
6. Click Save. The selected modules are available for your app to test with your test merchants.