CM Product Directory (CMPD) + Community + Payments - Use Case - Charging Users For Suggesting Products in Directory
Use Case - Charging Users For Suggesting Products in Directory
Note: This guide covers features from:
- CM Product Directory - This document uses version 1.7.7.
- Community Add-on - To allow users to suggest products. This document uses version 1.7.3.
- Payments Add-on - To charge users for suggesting products. This document uses version 1.2.5.
- Easy Digital Downloads (EDD) / WooCommerce - To connect payment gateways such as PayPal or Stripe
The Product Directory Plugin is a WordPress directory plugin that allows you to create product listings. By combining the Payments add-on and Community add-on you can charge users for creating and managing their product profiles.
Use Case Front-End
Submission page:
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/66670327d593d719515ca544/file-wCduGOsbVi.png)
EDD checkout page example:
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/666703f55173914f806c1932/file-qnSZEVuKcp.png)
Confirmation page example:
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/666704c0dd0f8c60bb3fce90/file-ncYRHt6mOd.png)
Quick Read: How It Works
- Easy Digital Downloads and WooCommerce provide the platform needed to collect payments for product listings.
- Once a non-logged in user submits a new product, their email is saved and a password is sent once the listing is approved.
- This process does not create a WP user associated with the listing. However, it still allows users to update their product listings information without having any access to the WP dashboard or having any other privileges related to WP users.
Use Case Assumptions
In this example use case guide, we'll cover how to charge users for suggesting and claiming products in your WordPress Product Directory website.
We consider that you have already bought the plugin and add-ons, but not installed them yet.
This documentation follows:
- Preparation
- Setting up payments
- Selecting Payment Plugin (WooCommerce / EDD)
- Requiring users to pay for adding products
- Requiring users to pay for claiming listings
- Requiring users to pay for renewing listings
- Notifying users
- User View - Suggesting and Paying
- Admin View - Tracking payments
- Extras
Installing the Add-on
The process is the same for all CM plugins and addons.
![CreativeMinds Customer Account Dashboard - Downloads tab](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/5ea2abc604286364bc98ef13/file-FEHseeA7Qu.png)
- Download the plugin from your customer dashboard.
- Log in to WordPress and navigate to the WordPress Admin → Plugins settings.
- Click on Add New.
- Activate it and add the license.
Installing Payment Plugin (EDD or WooCommerce)
You must choose between either Easy Digital Downloads or WooCommerce.
EDD or WooCommerce? No Difference For The Plugin
As far as Product Directory Payments add-on is concerned, there is almost no difference between using either EDD or WooCommerce.
Both payment plugins are free and provide free and paid add-ons. The only difference is that you can offer automatic renewals by using WooCommerce and its paid WooCommerce Subscriptions add-on
Head to Admin Dashboard → Plugins → Installed Plugins and click Add New.
![Installing new plugin](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/5ea681c604286364bc99094f/file-CVo5IF6Cpv.png)
Search for either Easy Digital Downloads or WooCommerce and install it.
![Searching for payment plugins for installation](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/5ea6827204286364bc990956/file-DY180qVeAW.gif)
Configure Payment Plugins
Don't forget to configure the payment plugin! This way you can connect it to payment providers such as PayPal or credit card companies.
Important
Be sure that your payment plugin has the correct Checkout and Cart pages set up. They are used by the plugin.
![Configuring payment plugins](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/5f2d6430042863444aa00272/file-L7pu3WrjzD.png)
External Resources
Setting up a Product Directory
First, set up the product directory if you haven't done so. Since this article focuses on the payment use case, it mostly list the relevant documentation for this first step.
Checking Settings
Navigate to Admin Dashboard → CM Product Directory Pro → Settings → General tab.
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/665de10cd593d719515ca030/file-3kbKpoFqOc.png)
Read more: CM Product Directory (CMPD) - Settings - General Settings
Adding Product
Go to Admin Dashboard → CM Product Directory Pro and click Product and then click the Add Product button or simply click the Add Product menu item.
Adding new product Fill in all fields, add Tags, Categories and Custom Taxonomy Terms. Optionally you can also add Video and Additional Links and Fields.
Filling product profile fields - When finished, click on the Publish button to save the Product.
Learn more: CM Product Directory (CMPD) - Add Product
Useful Guides
- Go to Admin Dashboard → CM Product Directory Pro → Settings to set plugin options:
- General - Set general options for plugin.
- Product Page - Settings for Product Page. More about Custom Taxonomy, Additional Links/Fields, Star Rating.
- Directory Index Page - General settings for Product Directory Index page and also Filters.
- Directory Appearance - Settings for three different views: Directory, Tiles and List view.
- Custom CSS - Option to apply your own custom CSS styles.
- Labels - Customize plugin labels to your needs.
- See the Shortcodes list to know what you can change to adjust the plugin to your needs.
Letting Users Suggest Products
Now, allow users to suggest products. We'll also skim through this part to focus on payments.
Learn The Basics
Navigate to the Admin Dashboard → CM Product Directory Pro → Settings → Community Product tab.
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/6666d19cdd0f8c60bb3fce6e/file-TRbVytEM3t.png)
Under Moderation Settings, choose the roles who can add products.
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/6666d23cdd0f8c60bb3fce6f/file-sJHzs8Gw2p.png)
Setting Up Payments
Now that the product directory is set up and users can suggest products, it's time to configure payments.
1) Selecting Payment Plugin (WooCommerce / EDD)
Let's start by telling the plugin which payment platform we are using (EDD or WooCommerce). Navigate to CM Product Directory Pro → Settings → Payments tab → Payment System Selection section.
Only one system can be enabled at a time. In the example below, We choose Easy Digital Downloads.
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/6666d3135173914f806c1911/file-9prYaWFaXf.png)
TIP: You Need a Payment Plugin
If you don't have EDD or WooCommerce installed, you will get the notice that payment features cannot work without one of these payment plugins.
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/6666d3a9e1989867dcefdbd3/file-PmaZItmwDx.png)
2) Requiring Users to Pay for Adding Products
Now onto the most important settings of the use case.
Head to the Add New Product Payments section and check Require payments for adding new products. We'll talk about the two other options in a moment.
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/6666d5a4d593d719515ca51a/file-1L5lCeAMG8.png)
Then, create a new WooCommerce/EDD product or assign the purchase with an existing product.
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/6666d62e5940934e140f4868/file-7up0uRZv6J.png)
TIP: This Defines How Much Users Will Pay to Submit Products
Technically speaking, users will buy a WooCommerce/EDD product that will grant them access.
Learn more: CM Product Directory Payments (CMPD Add-On) - Suggesting a Product
3) Requiring Users to Pay for Claiming Products
You can also charge users for claiming products. Turn on the option in the Claim Product Payments section.
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/6666d6d2e1989867dcefdbd7/file-pesQFiLDss.png)
And then set the product, like in the other payment settings.
User Perspective
Users can claim existing product listings by going to the listing page and clicking show by Claim this product.
They only need to add their name and valid email address to receive an email notification with instructions on how to pay for the listing.
Example
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/6666dafbdd0f8c60bb3fce73/file-ESoqDl3W1Z.png)
The rest of the process is the same as Suggesting a Product:
- User gets an e-mail.
- Pays.
- Gets another e-mail with an activation link.
Learn more: CM Product Directory Payments (CMPD Add-On) - Claiming a Product
4) Requiring Users to Pay for Renewing Products
Automatic Reminder vs Automatic Renewal
There's an important distinction. This add-on does not provide automatic renewals. When the subscription expires, it is not automatically renewed.
Instead, the user receives a configurable email notification.
If this feature is enabled, users must pay in order for their listing to remain visible to the public in the directory. This is also controlled by a (separate) product in EDD / WooCommerce to allow the payment.
![Product Directory Payments settings for renewing product listings](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/6666e04f5940934e140f486d/file-u3iX4wtxZK.png)
Mark existing items as paid
Check the box and save or click the button to set all current items as paid. The payments will be required only after renewal time passes.
Important
This will only work if the option Require payments for renewing products? was not checked earlier!
Time Settings
One huge difference is the time renewal and notification settings.
You can choose after how many days the listing will expire, requiring the user to make a new payment. Also, you can enable a notification to remind the user about the upcoming expiration.
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/6666e1f7dd0f8c60bb3fce7b/file-UAKV3IXy4U.png)
Front-end
After making the payment, the user receives a link to re-activate the listing or a unique activation code to paste on the product activation page.
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/6666e808d593d719515ca525/file-QMyqps5hnV.png)
Learn more: CM Product Directory Payments (CMPD Add-On) - Renewing a Product Listing
5) Notifying Users
In each of the options above (payment for adding, renewing and claiming), there are also options to customize the email sent to products. They follow the same pattern, with some changes:
- "Payment required" e-mail subject - Topic of the e-mail being sent after the user adds the product and it passes the moderation.
- "Payment required" e-mail content - Content of the e-mail being sent after the user adds the product and it passes the moderation. You can use the following placeholders:
- {product_name}
- {purchase_link}
- {activation_page}
- "Payment confirmation" e-mail subject - Topic of the e-mail being sent after the user purchases the product required to add a new product.
- "Payment confirmation" e-mail content - Content of the e-mail being sent after the user purchases the product required to add a new product. You can use the following placeholders:
- {product_name}
- {code}
- {activation_link}
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/6666ed3d5940934e140f4875/file-gSZupiCq5U.png)
TIP: Limited Free Listings
In the Limited Free Listing section, you can enable exactly that - and then choose which fields will be available in these limited profiles.
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/6666ee06d593d719515ca52a/file-W47AJp1VTh.png)
User View - Suggesting and Paying
With the Product Directory Payments add-on, the user submission process is the same as in the Product Directory Community add-on.
How To Edit Form
We explain in details how to configure the submission form in the documentation CM Product Directory Community (CMPDC) - Labels
But now, when users complete the product submission form, they will see a different message than usual. The message will mention payment.
Example
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/66670327d593d719515ca544/file-wCduGOsbVi.png)
What Happens On Submission?
You can control what will happen from the settings, section Add New Product Payments.
- Payment before moderation - If enabled, users will be able to pay even before the admin moderates the submission.
- Instant payment - If enabled, the user will be redirected to checkout immediately after filling the form. Requires Payment before moderation to be enabled.
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/6666ef70d593d719515ca52c/file-gnQvk2PTqo.png)
Checkout Page Example
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/666703f55173914f806c1932/file-qnSZEVuKcp.png)
TIP: Translate Interface
The add-on has over some labels that can be translated. These can be found in Settings → Payments Labels.
It's an opportunity to change the interface to your site's language and/or style.
Admin View - Tracking Payments
The add-on offers a simple way to track every payment made.
Definition
Product tokens are fully automated, virtual items created by the add-on to keep tracking of all of the actions requiring payments.
Accessing Token Dashboard
Navigate to the Admin Dashboard → CM Product Directory Pro → Product Tokens.
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/6666f2ad1f3fa9421e287c14/file-ziMsKc6cVD.png)
This screen will show a table with all recorded payments, along with their attached information.
Example
![Product Tokens dashboard](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/6666f52e5173914f806c1924/file-n9g9YEO88Y.png)
- Token before clicking on activation link from e-mail.
- Token after clicking on activation link from e-mail.
Editing a Token
Clicking on the code directs you to the token edit page, where you can change its status manually. Also here values like Purchase ID, email and types can be changed.
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/6666f661dd0f8c60bb3fce83/file-TznuzQ0K8U.png)
TIP: Activating and Deactivating, Changing Permissions
You can also activate or deactivate each token or edit its token type. Meaning the user will gain or lose permission to:
- Adding - Add product
- Claiming - Claim product
- Pay_per_view - Access product
Learn more: CM Product Directory Payments (CMPD Add-On) - Product Tokens Dashboard
Extra - Pay-Per-View: Charging Users For Accessing Profile
When Pay-per-view is enabled, users will be asked to buy a plan when trying to access a product profile. Select the plan and click Buy Selected Plan.
Example
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/6666fb76e1989867dcefdbf7/file-zShddlNdpv.png)
Settings
To enable this feature, head to the Payments tab → Pay-per-view section.
First, enable the option Turn on the Pay-per-view.
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/6666fc191f3fa9421e287c1e/file-qAsHi1QYkX.png)
Then configure:
- Easy Digital Downloads / WooCommerce Product Association - Select an existing EDD / WooCommerce Product which will be required to use the "Pay-per-view" functionality. Or choose the name and price and click "Create New EDD / WooCommerce Product" to automatically create and assign a new Product.
- Pass items - Number of possible items to be displayed after purchasing a single "pass".
- Pass days - Number of days the purchased "pass" is valid after it's activated.
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/6666fcbbdd0f8c60bb3fce88/file-1jGd6TZVIX.png)
Multiple!
Remember you can add multiple plans!
Learn more: CM Product Directory Payments (CMPD Add-On) - Pay Per View
Recap
With all steps completed, your directory will require payments before user submissions are online.
Use Case Front-End
Submission page:
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/66670327d593d719515ca544/file-wCduGOsbVi.png)
EDD checkout page example:
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/666703f55173914f806c1932/file-qnSZEVuKcp.png)
Confirmation page example:
![](http://d33v4339jhl8k0.cloudfront.net/docs/assets/558f9e89e4b01a224b42f278/images/666704c0dd0f8c60bb3fce90/file-ncYRHt6mOd.png)
![]() |
More information about the CM Product Directory WordPress Plugin Other WordPress products can be found at CreativeMinds WordPress Store |
![]() |
Let us know how we can Improve this Product Documentation Page To open a Support Ticket visit our support center |