In this partner setting, you will find below settings:
Billing Type
Stripe Automatic Tax(Internal Billing)
Billing URL
Login Page Theme Settings
Credit Billing for Addons
Webhook URL
Web Chat Support
Default Languages
Default Flow Theme
Free Trial Days
Free Trial Options
User Registration
Signup Email Verification
Require Vat ID
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
We will go through the setting one by one.
Billing type
We offer two different billing type. it’s billing URL and Internal Billing.
Internal Billing
If you have Stripe account, we would suggest you select “Internal Billing” option, and then go to your main partner workspace integration tab, and connect your Stripe account.
...
| Note |
|---|
Please note, using Stripe billing automation, it will automate create new workspace, not upgrade existing workspace. And also you need to make sure you have enough partner credit in your wallet. |
Connect your Stripe account
First, you need to connect your Stripe account, you need to go to “Integration”, and then “Stripe”
After you connect your Stripe account, it will show up like this:
...
Create Stripe subscription product
You can create subscription product directly in Stripe or create product through 3rd party platforms like Thrivecart & GoHigh Level.
...
And then you can update your product details like name, description, image, and recurring pricing, check the screenshot below:
...
Stripe Automatic Tax Setting
If you want to create VAT/Tax in the product you set up in Stripe, you can turn on the Stripe automatic tax setting, and then the subscription will collect GST in the purchase.
After you save your products, Next step, you will be able to connect this subscription plan with your paid plans in UChat.
| Note |
|---|
Please note, you can also create the Stripe subscription product through 3rd party platforms like Thrivecart or Go High Level. The same subscription products purchase can also be automated if you link the product with any of your paid plans. |
Connect Stripe Subscription with your plans
Now, after you created your Stripe billing plan, it’s time for you to link the subscription plan with your paid plans.
...
| Note |
|---|
Make sure you link to the price you want to sell, and select “Internal Billing” in the template dropdown. |
And also you can select the templates you want to install when this plan is purchased.
...
After you selected, please make sure you actually save the plan & templates assigned.
...
Add Partner Credit
Make sure you have enough of the credit in your partner wallet, otherwise the upgrade won’t be successful.
The partner credit should at least cover the cost of the plan you are upgrading.
For example, you are upgrading the default business plan, the cost of that plan is $10, so you should at least have $10 in your partner credit.
If you don’t have enough partner credit, when the user click the upgrade button, it will show error message to contact support.
Test the purchase
After you set up & link Stripe subscription to your plan, now it’s time that you can do a simple test.
Make sure you have enough partner credit to cover the cost of the plan you are testing with.
Do a demo purchase, and then see check if the user’s new workspace created is updated successfully or not. and see if the template you choose installed in the omni channel or not.
| Note |
|---|
Make sure you have enough of the credit in your partner wallet, otherwise the upgrade won’t be successful. It will trigger the “no_enough_credit” event if you set up webhook URL to listen the events. |
If you are existing user
if you are existing user, which means your email on the checkout page is the same as the email to login your white label partner platform, then after the purchase, we will actually create a new workspace under the same email login, and also install the template you have assigned to this workspace.
If you are new user
If you are new user to your platform. We will actually send the welcome email from your own email STMP(if you have set up by following this tutorial).
And since we automatically create a random password for the new user, so it’s best practice that you reminder the user to reset their password to get access to their workspace.
If you set up webhook events in your partner settings:
...
And in our partner API, you should be able to pick up the following event:
...
And then you can set up your own automation to reminder the user to reset their password.
Transaction history check
If you have enough credit in your partner wallet, you will find the transaction history as per the screenshot below.
...
If you don’t have enough credit in your wallet, and you will be able to receive “no_enough_credit” event to your webhook.
You need to follow our partner API documents here to set up the webhook URL.
...
Purchase cancellation automation
So if your customer want to cancelation the plan, you can simply go to your Stripe account, and select the customer & subscription, and cancel it for them.
...
For the cancellation, you can choose to cancel immediately or cancel at end of the current billing cycle.
if you choose cancel immediately, the customer’s workspace will immediately drop to the free plan. If you choose to cancel at the end of current billing cycle. We will drop their workspace to the free plan at the currently billing cycle.
| Note |
|---|
Please note, this automation will only work if they subscribed through the Stripe billing automation. |
Purchase cancellation automation
So if your customer want to cancelation the plan, you can simply go to your Stripe account, and select the customer & subscription, and cancel it for them.
...
For the cancellation, you can choose to cancel immediately or cancel at end of the current billing cycle.
if you choose cancel immediately, the customer’s workspace will immediately drop to the free plan. If you choose to cancel at the end of current billing cycle. We will drop their workspace to the free plan at the currently billing cycle.
| Note |
|---|
Please note, this automation will only work if they subscribed through the Stripe billing automation. |
Billing URL
If you don’t have Stripe account, or can’t set up Stripe account, you want to use your own payment gateway, you can choose to use “Billing URL”.
You should build your own checkout page on your own domain, and you have the below variable to use in the checkout URL.
Workspace ID
Workspace name
Owner name
Owner email
Plan ID
...
Manually Upgrade
After receiving the payment from your own checkout page, you can go to “White label Settings” → Workspaces, and manually upgrade the user the plan they purchased.
Collect workspace ID on checkout page
In this section, we will show you how to upgrade customers’ workspace after your customer pays directly to you.
One of the benefits of the UChat partner program is that you can charge the price you want and get 100% of the profit.
In order to upgrade your customer's workspace after the payment, you will need to ask for a workspace ID from your customers.
...
They can find the workspace ID in their workspace settings. You can also include where to find the workspace ID at your checkout page if you want.
...
Make sure you ask or make this field mandatory on your checkout pages if you want to use our partner API to upgrade automatically for them.
Manually upgrade customer’s workspace
After you collect the payment from your customer, you will also have their workspace ID. and then you can go to your white label settings under your custom domain or under the UChat domain.
You can search the workspace ID, and then upgrade customers’ workspace or add extra add-ons.
...
If you haven’t collected workspace ID, you can also search by owner’s email address and workspace name.
...
After you identify the workspace, you can upgrade for them manually. Please note that you need to have enough credit balance in your wallet to upgrade for them.
Automate with Partner API
Or you can connect with UChat partner API, and automatically upgrade the workspace to the plan they purchased.
In the UChat partner API, you can call the partner API to change plan:
https://www.uchat.com.au/partner-api#/Partner%20Management/partnerChangePlan
In this api request, you will need to provide: workspace ID & plan name, you can get the plan details from the api endpoint:
https://www.uchat.com.au/partner-api#/Partner%20Management/partnerPlans
If you want to automate the upgrade process, we will need the workspace ID, so you can add the workspace plan ID dynamically at the checkout URL or ask the workspace ID in your own checkout page.
ThriveCart Checkout URL automation
Thrivecart is a 3rd party checkout platform, in this tutorial, we will show you how to set up billing url automation using 3rd party checkout platforms.
Learn more details from the link here.
Login Page Theme Settings
You can find the login page theme settings in the partner settings.
We offer 4 different login page designs by default.
Apple theme
...
Banana Theme
Cherry Theme
...
Credit Billing For Addons
Learn more about addons credit billing here.
Webhook URL
In the partner API, you can choose to receive the below events, and set up your own automation for onboarding, and customer retention, payment reminder, etc
The events you can receive:
User_registered
User_email_verified
Workspace_created
Workspace_deleted
Workspace_paused
Bot_created
Bot_deleted
Plan_changed
Plan_renewed
Addon_renewed
Overdue
No_enough_credit
No_enough_points
Usage_alert
...
Web Chat Support
This is the feature for you to offer web chat support for all workspaces under your custom domain.
Once it’s enabled, this web chat chatbot that connected to the omni channel will be used for the chat across all your partner workspaces.
...
Default Language
UChat platform support multiple languages, and can be easily extend to other languages.
The language we current support are:
English
Arabic
Kurdish
Deutsch
Espanol
French
Hebrew
Japanese
Korean
Dutch(Netherlands)
Polski
Portugues
Portuges Brasileiro
Turkish
Chinese
You can select the language you want as the default language, and then all the new workspaces created under your own custom domain will be set into that language.
Also all the welcome email, forgot password email will be using your selected language.
| Note |
|---|
If there are certain content in the email still haven’t translated into the language you choose, you will need to identify the string, and update the translation from the our github link below: |
However every user will still have the opportunity to change the language to other languages. They can select the user profile from the top right corner of the dashboard, and then select the language they want to switch into.
...
Default Flow Theme
UChat offers multiple flow builder theme, you can preview and test from the flow builder settings.
If you click “Change theme”, and then you can preview all the theme we offers.
...
Once you choose the flow builder theme, then all the new workspace created under your custom domain will use that theme by default.
System Email Profile
This settling allow you to set up a default email SMTP profile for all the workspaces under your own custom domain.
You need to set up email SMTP profile in your main UChat partner workspace. Once it’s set up, you need to select that email profile in this setting, and then in every workspace under your custom domain, if your customer want to use the “send email” action or Email notifications, they will see the default email smtp option like screenshot below:
...
Video tutorial
...
Free Trial Options
In this help document, partner will have different options to set up the free trial.
Check the video below for more details:
...
Offer different days of free trial
You will find free trial days settings in White label settings → Partner settings, and by default, we offer 14 days free trial for every workspace created under your custom domain.
However, you can change this by setting up your own free trial days.
Free trial for new users
If you choose this free trial for new users, that means every email/every user will only get the free trial workspace when they created their first workspace.
All the new workspace created under the same email will be under free plan. They will need to subscribe to your paid plan in order to use the pro feature.
Free trial for new workspace
If you choose free trial for new workspace, then every new created workspaces will have the 14 days free trial. And the user can decided to upgrade during or after 14 days free trial.
User Registration
You can turn on or off the default sign up option if you don’t want to use our default sign up page.
If you turn it off, you will not see the sign up link at your default login page.
...
If you leave the setting on, you will see the default sign up page link as per the screenshot below
...
Sign Up Customerization
Enable/Disable User Registration
By default, there is a sign up link on the login page URL, it’s offered by us,
...
If you disable the sign up link, and then the login page URL will not show up.
Instead you can build your own sign up page, and potentially connect with partner API to create workspace after the form submitted.
Collect Phone number
If you enable the phone number on the sign up page, then you will see the below phone number option on the sign up page.
...
After the phone number is collected, you can see the phone number from the clients list, and also you will be able to receive the customer information from the partner webhook URL.
...
Disable Email Verification
By default, every new user will receive a verification email, if you set up your own email SMTP, then the email will send from your own email address.
If you disable this setting, then your customer will not receive verification email. All the new workspace created through partner API or registered on the sign up page will login and get access immediately.
Pricing Page Note
If you want to add some announcement on the billing page, you can add the content here, and it will show up at the billing page as per screenshot below
...
Require VAT ID
For some countries, it’s required to collect the VAT ID from the customer. it’s mandatory.
If you are not using Stripe - Stripe Automatic Tax to collect tax, you can use the VAT ID to get this information before the customer pay you.
It will show up like the screenshot below.
...