You are browsing myClubhouse Knowledge Base
Token Payments
Tokens can be used as an alternative way to pay for items in myClubhouse. Tokens can also be used as a pre-payment system, or as a reward scheme.
Token Setup
Navigate to Admin > Settings > General Club Settings.
Navigate to the “Finance” Tab.
Complete the “Tokens” section:
Term used for the token payment system: Set the name for the Token system as a whole, such as “points”, or “bar credit”.
Term used for a payment token: Set the name of each Token, such as coin, or point.
Token Value:
No monetary value: Tokens will not have a set monetary value. Users will only be able to pay for items pre-set with a Token cost, see below.
Monetary Value: You can assign a monetary value to each Token if you want users to be able to spend their Tokens on anything in their basket. This will often be used as a part payment, with the remaining balance to be paid for by another payment method. If you select this option, you should not set the cost of any items in Tokens.
Treat as Money: This is similar to a Monetary Value as each Token will have a value of £0.01 (or the smallest denomination in your system’s currency), but Tokens/balances will be shown in a money format (£#.##) rather than just a number of tokens. If you select this option, you should not set the cost of any items in Tokens.
When changing the settings of your existing Tokens configuration to treating them as money, you will be given some additional options as part of the conversion process:
Update Balances: If set to “Yes”, balances will be updated so that the monetary value of the user’s previous balance will be the same monetary value of their new Token balance. E.g. If Tokens are worth £5.00 each and I have a balance of 4 (totalling £20.00), after the switch, Tokens are worth £0.01 so I now have a balance of 2000 Tokens, still worth £20.00.
Update Transactions: If set to “Yes”, historical transactions will be updated so that the Token value maintains the same monetary value as the new system. E.g. A member paid 1 Token for an Event Sign-up when they were worth £5.00 each; after the switch, Tokens are now worth £0.01 so this transaction will be updated to have cost 500 Tokens.
Rounding Mode: “Nearest” will move to the nearest whole number, either up or down; “Round Up” will always round up to the nearest whole number; and “Round Down” will always round down to the nearest whole number.
Time to expiry of transferred Tokens: When Tokens are transferred between users, they will expire after the number of days set here. If blank, the transferred Tokens will not expire.
Low Token Warning Threshold: If set, an email (Auto-generated Email “TOKENS_LOW”) will be sent to the user when their Token balance is less than or equal to this threshold. Whether it is set or not, an email (Auto-generated Email “TOKENS_NEGATIVE”) will be sent to the user when their Token balance drops below 0.
Maximum Token Overdraft: Set the number of Tokens that each user can go below 0. For example, if you enter 10, each user’s balance can go as low as -10 Tokens.
Save Changes: Once happy with the details, click “Save Changes” to apply them.
Token Amendments
Token Amendments can be used to credit or debit a user’s Token balance.
Navigate to Admin > Finance > Browse Token Transactions.
Click “Add Amendment”.
Complete the wizard:
Token Account: Start typing the name of a user and select it from the dropdown.
Time: Set the time and date the amendment should take place.
Description: Enter a short description of why the amendment is being performed.
Amount: Enter the amount of Tokens to be added to or removed from the user’s balance using positive or negative numbers as appropriate.
Expiry Date: If crediting a user with tokens, enter when these Tokens should expire. If left blank, these Tokens will not expire.
Notes: Enter any notes regarding the amendment.
OK: Once happy with the details, click “OK” to make the amendment.
Token Transfer
Tokens can also be transferred from one user to another. The “Transfer Tokens to another member” Entitlement controls who can transfer Tokens from their own or a family member’s account to another.
Navigate to the user’s profile.
Click “Token Transactions” to jump down to the correct section.
Click “Transfer”.
Complete the wizard:
To Member: Start typing the name of the receiving user and select it from the dropdown.
Amount to transfer: Enter the number of Tokens to be transferred. This must be less than or equal to the user’s current balance.
Comments: Enter the reason for the transfer, and any other comments.
Transfer: Once happy with the details, click “Transfer” to perform the transfer.
Awarding Tokens
There are a variety of ways that Tokens can be given to users. Different methods suit different scenarios depending if it is recurring or a one off, if money is being paid in exchange for the Tokens, and if the awarding of Tokens needs to be carried out by the user themselves, or an administrator.
Bulk Award
Sometimes you want to award Tokens to a group of users for the same reason, this tool makes it easy.
Navigate to Admin > Finance > Browse Token Transactions.
Click “Bulk Award Tokens”.
Complete the wizard:
Mode: Select to choose your members individually or from a Member List.
Members: Select the Member List from the dropdown, or start typing the names of users and select them from the dropdown.
Time: Set the time and date the amendments should take place.
Description: Enter a short description of why the amendment is being performed.
Amount: Enter the amount of Tokens to be added to each user’s balance using positive or negative numbers as appropriate.
Expiry Date: If crediting a user with tokens, enter when these Tokens should expire. If left blank, these Tokens will not expire.
Notes: Enter any notes regarding the amendment.
OK: Once happy with the details, click “OK” to make the amendment.
Events
Attendees to an Event can be rewarded for attending with Tokens. For Event series, this can be on an instance or series level.
Navigate to Events > Events Calendar.
Click “Create Event”.
Click on the “Costs” tab.
Event has costs or sign-up options: Change this to “Yes”.
Payment Options: Make sure “With Money” is selected. You can either select or deselect “With Tokens”.
Instance Reward: Enter the number of Tokens awarded per instance, or for the whole single Event, to each attendee.
Series Reward: If creating an Event Series, enter the number of Tokens the Series sign up will cost.
Token Expiry: Enter when these Tokens should expire. If left blank, these Tokens will not expire.
Complete the rest of the wizard.
Create Event: Once happy with the details, click “Create Event” to create the Event.
Learn more about Events in these guides: How to Create a Single Event | How to Create an Event Series
Pricing Structure
When using Pricing Structures for different sign-up options, you can also choose between options with and without Token Rewards.
Shop
A popular way that members can purchase Tokens to spend in other parts of your myClubhouse site.
Navigate to Shop > Browse Club Shop.
Click “Add Product”.
Navigate to the “Pricing” tab.
Complete the “Token Reward” section:
Tokens per unit: Set how many Tokens the user is purchasing at a time.
Token Expiry: Set how many days after purchase that these Tokens will expire. If blank, the Tokens will not expire.
Complete the rest of the wizard.
Click “Save” to add the new Token product to the Shop.
Learn about selling Tokens in the Shop in this guide: Club Shop | Add Product, making sure to complete the
Subscriptions
Tokens can be awarded to a member when they accept and pay for a Subscription.
Navigate to Subscriptions > Membership Categories.
Click “Edit” or “Copy” next to an existing Membership Category, or click “Add Category”.
Navigate to the “Costs” tab.
Award Tokens on purchase: Set to “Yes” to award Tokens to the member who purchases a Subscription of this Category.
Token Award: Set how many Tokens will be awarded to the member when they purchase a Subscription of this Category.
Token Expiry: Choose whether these Tokens expire on the end date of the Subscription, a set number of days after the Subscription is paid for, or not at all.
Complete the rest of your Membership Category setup, and click “Save Changes” to save the new configuration.
Learn more about Membership Categories in this guide: How to Create a New Membership Category
Profile
Tokens can also be topped up/purchased via a user’s profile page.
Setup
Navigate to Admin > Settings > General Club Settings.
Click on the “Finance“ tab.
Set “Top Up from Profile“ to “Yes”.
How is the member going to pay: Select a Payment Scheme for members to use when paying for Tokens from their profile. Learn more about Payment Schemes in this guide: Payment Methods, Plans, and Schemes
Minimum Top-up: Set the minimum number of Tokens that a member must top up at once. If this is blank, there will be no minimum top-up.
Token Expiry: Set when Tokens that are topped up via the profile will expire. If this is blank, Tokens added in this way will not expire.
Top Up at Monetary Value: If Tokens have a monetary value, choose whether Tokens can be topped up by their monetary value. E.g. if Tokens are worth £5 each, members can top up their Token balance by £10, rather than 2 Tokens.
Token Purchase Units: Add quantities of Tokens and their cost for members to choose from when topping up their Tokens via their Profile page. This allows you to offer discounts on larger quantities of Tokens.
Usage
When a member wants to top up their Token balance via their profile page they need to:
Navigate to their profile page.
Scroll down to the Tokens section.
Click “Top Up Balance”.
Complete the wizard:
Amount to Credit: If “Top up at Monetary Value” is set to “No”, click a combination of top-up values to reach the desired amount to top up by.
If “Top Up at Monetary Value” is set to “Yes”, enter the amount of Tokens you want to top up by.
Cost: The cost will update as Tokens are added to the “Amount to Credit”.
Card: Select which card from your pre-saved Stripe cards you would like to pay with. You can add new Stripe cards from your Profile page, or when paying for items through Stripe in the basket.
OK: Once happy with the amount and the cost, click “OK” to process the payment and top up your Token balance.
Spending Tokens
When spending Tokens, the system will always prioritise spending the user’s Tokens that are set to expire first.
Events
Events can be paid for with Tokens. Whether it is a Series or a Single Event, the cost can be set using money and/or Tokens.
Navigate to Events > Events Calendar.
Click “Create Event”.
Click on the “Costs” tab.
Event has costs or sign-up options: Change this to “Yes”.
Payment Options: Select “With Tokens”. You can either select or deselect “With Money”.
When will the Tokens be debited: Choose when, in relation to the Event, that the user’s Tokens will be deducted from their Token balance.
Instance Cost: Enter the number of Tokens an instance, or the whole single Event, sign up will cost.
Series Cost: If creating an Event Series, enter the number of Tokens the Series sign up will cost.
Complete the rest of the wizard.
Create Event: Once happy with the details, click “Create Event” to create the Event.
Pricing Structure
When using Pricing Structures for different sign-up options, you can also have different options with Tokens.
Sign-Up
When a user comes to sign up for an Event, the sign-up wizard will show the option to pay with Tokens (it could be the only option):
Bookings
Tokens can be used as well as or instead of money to pay for Bookings. You set it at the Asset level, so you can choose certain Tokens to be paid for using Tokens, and some with money if you wish.
Navigate to Bookings > Admin Booking Systems.
Click “Configure” next to the Booking System you want to edit.
Click “Edit” next to a Bookable Asset Types, or click “Add Bookable Asset Types” to create a new one.
Complete the wizard:
Costs Apply: Select “Yes”.
How members can pay: Select “With Tokens”. You can either select or deselect “With Money”.
Token Cost: Enter the cost of each Booking in Tokens. This can be adjusted in the Booking Rules.
Complete the rest of the wizard.
OK: Once happy with the details, click “OK” to save the Asset Type so it is ready to use.
Shop
As well as being a place to sell Tokens, it can also be a place for users to spend their Tokens.
Navigate to Shop > Browse Club Shop.
Click “Add Product”.
Navigate to the “Pricing” tab.
How can members pay for the product: Select “With Tokens”. You can either select or deselect “With Money”.
Token Cost: Set how many Tokens the product will cost.
Complete the rest of the wizard.
Click “Save” to add the new product to the Shop.
Basket
When Tokens have a monetary value, they can be applied to any purchase within myClubhouse. This means that they can be applied/spent in the basket, partially or fully towards a purchase.
When you click “Use Tokens” the system will spend the maximum number of Tokens available to reduce the cost of the items in your basket, while only spending whole Tokens. For example, if I have an Event sign-up costing £26.00 in my basket and Tokens are worth £5.00, the system will spend 5 of my Tokens leaving me £1.00 left to pay through other means. If I only had a balance of 2 Tokens, then these 2 would be deducted and I would be left with £16.00 left to pay.
If the Token spend reduces the remaining cost down to £0, you will need to click “Confirm Zero-Cost Purchase” to complete the transaction and clear the items from your basket.
Other Token Admin
Token Balance
A user’s Token balance can be located in 2 places:
When signed in, the user can see their current Token balance in the menu bar.
A user’s current Token balance can also be viewed on their profile page.
Token Transactions
The history of Token transactions can be viewed in 2 places:
All Token transactions can be viewed at Admin > Finance > Browse Token Transactions. You can sort, filter, and add and remove columns to narrow down the list. You can also save Views to refer back to later.
You can view a user’s Token transaction history from their profile. The most recent transactions are displayed there, but a full list can be seen by clicking “Manage” to the top right of the table.
Refund Unused Tokens
Force to pay using Tokens
If your system has set Tokens to have a monetary value or Tokens are to be used as money, you may wish to mandate that some items can only be purchased with Tokens. To do this, you will need to create a Payment Scheme that has no Payment Methods in it, similar to this:
When purchasing items with this Payment Scheme, users will be forced to use their Tokens when paying in the basket.