# MemberMouse

> *"MemberMouse™ is an easy to use WordPress membership plugin that allows you to sell products, subscriptions and memberships, setup a password protected member's area, offer 1-click upsells and downsells, manage customers, automate customer service, track critical retention metrics and more. No matter where you're starting from, MemberMouse has the power you need to maximize revenue and get your business running like a well-oiled machine."*

<https://membermouse.com/>

* [Enabling MemberMouse](#checkoutchampmembermouse-enablingmembermouse)
* [Using MemberMouse Inside the CRM](#checkoutchampmembermouse-usingmembermouseinsidethecrm)
  * [Configuring a CRM product to use MemberMouse](#checkoutchampmembermouse-configuringacrmproducttousemembermouse)
  * [Associating a base product with a MemberMouse product bundle](#checkoutchampmembermouse-associatingabaseproductwithamembermouseproductbundle)
  * [Associating a base product with a paid MemberMouse membership level](#checkoutchampmembermouse-associatingabaseproductwithapaidmembermousemembershiplevel)
  * [Apply the MemberMouse base product to a campaign offer/upsell](#checkoutchampmembermouse-applythemembermousebaseproducttoacampaignoffer-upsell)
* [Locating Membership Customers](#checkoutchampmembermouse-locatingmembershipcustomers)

***

## Enabling MemberMouse <a href="#checkoutchampmembermouse-enablingmembermouse" id="checkoutchampmembermouse-enablingmembermouse"></a>

1. Go to the **Admin →** **Plugins** page.
2. Pick the **Membership Services** tab.
3. Click on the **Member Mouse** tile.

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2FMZC3visBmYTM4iBQG2xO%2Fimage.png?alt=media&#x26;token=ab295d45-89ca-4893-bae4-65bee1c52ecc" alt=""><figcaption></figcaption></figure>

4\. Click **+ Activate**.

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2FyytE7cKQVzELQWMndQdH%2Fimage.png?alt=media&#x26;token=a788ac4f-2b89-437f-b4a9-19ae12b61656" alt=""><figcaption></figcaption></figure>

5\. Fill in your **apiUrl**, **apiKey**, and **apiSecret** that you got **from MemberMouse**.

Fill in the MemberMouse **membershipLevelId** that you want new customers to be added to by default. If this is a **paid** MemberMouse membership level, then you must also **check** the **paidMembership** checkbox. Otherwise, leave the checkbox unchecked. When you are finished, click **Connect**.

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2FgReICBtQISze1rUJXXYm%2Fimage.png?alt=media&#x26;token=f4c67551-e848-442d-b05d-68444620fd8b" alt=""><figcaption></figcaption></figure>

## Using MemberMouse Inside the CRM <a href="#checkoutchampmembermouse-usingmembermouseinsidethecrm" id="checkoutchampmembermouse-usingmembermouseinsidethecrm"></a>

#### Configuring a CRM product to use MemberMouse <a href="#checkoutchampmembermouse-configuringacrmproducttousemembermouse" id="checkoutchampmembermouse-configuringacrmproducttousemembermouse"></a>

1. Go to the **CRM → Products** section from the navigation sidebar.

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2F6u4UTNddVlBEnbnWf1IE%2Fimage.png?alt=media&#x26;token=9bdd58fe-2fa7-4176-9169-c31c325dbe51" alt=""><figcaption></figcaption></figure>

2\. **Add** a new product or **Edit** an existing product that you want to use MemberMouse.

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2F59EME1tXotpLMxhMBuUK%2Fimage.png?alt=media&#x26;token=bb24eb98-19b6-423a-9984-563da65096d8" alt=""><figcaption></figcaption></figure>

3\. Click the **Membership Club** drop-down and **select MemberMouse**.

4\. Set the **clientProductId** to match a specific product bundle or membership level in MemberMouse (**see below for details**)

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2FYDgJk6312klwtHzRbQsp%2Fimage.png?alt=media&#x26;token=8be85c3a-b482-49c4-8939-c21a6e6f655e" alt=""><figcaption></figcaption></figure>

#### Associating a base product with a MemberMouse product bundle <a href="#checkoutchampmembermouse-associatingabaseproductwithamembermouseproductbundle" id="checkoutchampmembermouse-associatingabaseproductwithamembermouseproductbundle"></a>

This adds a product bundle to a customer's current membership level. This is the most commonly used configuration for MemberMouse membership products.

* Set the product's **clientProductId** (client ID) to "BUNDLE:\[bundleId]", where **\[bundleId]** is MemberMouse's product bundle id.

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2FrHc2WCghrXRLA88fRZNT%2Fimage.png?alt=media&#x26;token=ec004f8e-2b15-456a-8555-ea109345fa9e" alt=""><figcaption></figcaption></figure>

#### Associating a base product with a **paid** MemberMouse membership level <a href="#checkoutchampmembermouse-associatingabaseproductwithapaidmembermousemembershiplevel" id="checkoutchampmembermouse-associatingabaseproductwithapaidmembermousemembershiplevel"></a>

This **sets** a member's current membership level, changing it from the default configured in the plugin configuration. This is used to move a customer from a **free** membership level to a **paid** membership level, or to otherwise **upgrade** their membership level.

* Set the product's **clientProductId** to "MEMBERSHIP:\[membershipLevelId]", where **\[membershipLevelId]** is MemberMouse's membership level id.

#### Apply the MemberMouse base product to a campaign offer/upsell <a href="#checkoutchampmembermouse-applythemembermousebaseproducttoacampaignoffer-upsell" id="checkoutchampmembermouse-applythemembermousebaseproducttoacampaignoffer-upsell"></a>

1. Go to **CRM → Campaigns** to create or edit a campaign

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2FY3Pkkk8K3xZgaGRP73rs%2Fimage.png?alt=media&#x26;token=f809294e-c545-4266-91c8-cb7ed2b40d41" alt=""><figcaption></figcaption></figure>

2\. Create or edit the offer/upsell which will be associated to the MemberMouse membership

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2FQts2RVIrVDvB2W0FGJOD%2Fimage.png?alt=media&#x26;token=b0d3756b-cc39-48c8-ba1a-7b0634ebd39e" alt=""><figcaption></figcaption></figure>

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2FNkyBlCQuMMfu4xOut53i%2Fimage.png?alt=media&#x26;token=734ebaf4-be41-4411-8f4a-1110f6c9dcae" alt=""><figcaption></figcaption></figure>

***

## Locating Membership Customers <a href="#checkoutchampmembermouse-locatingmembershipcustomers" id="checkoutchampmembermouse-locatingmembershipcustomers"></a>

To locate customers on your membership club, navigate to Customers → Memberships within the CRM. Here you can search for customers by using the search filters.

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2FUCVdX9jbBahBCCzBBT5p%2Fimage.png?alt=media&#x26;token=0d985be6-e886-4fad-9473-79e9f4bc5899" alt=""><figcaption></figcaption></figure>

On the customer’s profile, click the “Clubs” tab to view/edit the customer’s memberships.

<figure><img src="https://3790748257-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FT43PzcNjyZtWby9yrGd3%2Fuploads%2FB0IzhmeyOMurddgtOVCg%2Fimage.png?alt=media&#x26;token=302dcfe4-c9e4-4f22-b79f-6142aa20e00c" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.checkoutchamp.com/crm/plugins/membership-services/membermouse.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
