# CustomClub

**CustomClub is an in-house Membership Platform built for CheckoutChamp CRM Clients.**

{% hint style="info" %}
You can create as many CustomClub plugins as you need and you can tie them to as many membership products as you need. CustomClub plugins can also be used across multiple campaigns.

It is best, however, that any given campaign only has a single CustomClub plugin associated with it as having multiple tied to the same campaign could cause issues with the system identifying the correct club to log the customer into, resulting with the Invalid Credentials error.
{% endhint %}

{% embed url="<https://api.media.atlassian.com/file/cd1c6e23-f342-40ef-8c0f-bae6c24e61b2/artifact/video_1280.mp4/binary/cdn?client=275b7238-9394-4b3c-903b-1514a78b0763&collection=contentId-2098040992&max-age=2592000&token=eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiIyNzViNzIzOC05Mzk0LTRiM2MtOTAzYi0xNTE0YTc4YjA3NjMiLCJhY2Nlc3MiOnsidXJuOmZpbGVzdG9yZTpjb2xsZWN0aW9uOmNvbnRlbnRJZC0yMDk4MDQwOTkyIjpbInJlYWQiXX0sImV4cCI6MTc0OTE0ODE1MCwibmJmIjoxNzQ5MTQ1MjcwLCJhYUlkIjoiNjA4ODY4YTU1NDMyNjQwMDY4NTIzZjMzIn0.AKUyktP3J2ph0XyqNLnJzPEkxC7FuaKqhO_EsFX22sk>" %}

To Activate this plugin, navigate to Admin → Plugins → Membership Services

* **clubName** - Internal identifying name
* **memberIdType** -
  * **Sequential**: (In sequence this will be assigned a member number based off when entered ex Membership 1, 2, 3... Etc.)
  * **Phone Number**: (Create a membership based off the Phone number.)
  * **Random Hex**: This is a random string of letters and numbers generated to each member entered into the system.<br>
* Check the **"GenerateUserPass"** box if you want CheckoutChamp to *automatically* generate the users username and password.
  * If you uncheck this box, you can use the Update Membership API to update the customer’s membership credentials.
* Check the **"oneClubPerCustomer"** box if you want each customer to have a single set of credentials for the plugin. If one customer purchases multiple products in the club then all the subscriptions will have the same credentials.
  * If you uncheck this box, then every time a customer purchases a club product a new unique set of credentials will be issued to the customer for that product.

<figure><img src="/files/Vekn4e8BizOZFlEoLZOF" alt=""><figcaption></figcaption></figure>

Once CustomClub is created, navigate to CRM → Products to apply the *Membership* to the **Base Product**.

* **General Details** Create your Product Name.
* Under Fulfillment Details fill in your details and select your Membership name and click on the "Blue" **Update** Button.

**Note: Once the product is purchased it will Start the Membership.**

<figure><img src="/files/oWxh7cPI4rboVEBvJqSM" alt=""><figcaption></figcaption></figure>

**Note: The club Username will initially be set to the customer's email address.**

Send Membership Information to the Customer though Initial Order, Recurring Order, or All Orders Event Type Auto-responders Inside of the Campaign using these *Tokens*-

* **Membername** \[clubMemberId]
* **Username** \[clubUsername]
* **Password** \[clubPassword]

<figure><img src="/files/5Qe2gMysiB8fn9NufTHS" alt=""><figcaption></figcaption></figure>

**CheckoutChamp Membership APIs**

* [**Query Club Memberships**](https://apidocs.checkoutchamp.com/#af41047c-7d6f-4c23-8f07-73f00301f3e2)
* [**Cancel Club Membership**](https://apidocs.checkoutchamp.com/#a738ab7a-cd24-4e83-9c3f-ce906d190e37)
* [**Reactivate Club Membership**](https://apidocs.checkoutchamp.com/#94222d2f-9272-4eda-af01-d0899e40fa73)


---

# 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/customclub.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.
