Upmind

https://docs.upmind.com/docs/getting-started
Admin
Upmind is a comprehensive business automation platform for managing clients, services, billing, and...
Tokens:23,967
Snippets:129
Trust Score:9.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example Rapid Order URL

Source: https://docs.upmind.com/docs/getting-started/place-a-rapid-order-experimental

This example demonstrates a complete rapid order URL, showing how the product and fields parameters are encoded after processing. It illustrates the final structure of the URL for deep linking.

```Text
https://{ YOUR_UPMIND_INSTANCE }/order/_?product=%257B%2522product_id%2522%3A%252201e96d29-8537-d4e5-025c-54e120637085%2522%2C%2522quantity%2522%3A1%2C%2522billing_cycle_months%2522%3A12%257D&fields=%257B%2522domain_name%2522%3A%2522example.com%2522%257D
```

--------------------------------

### Example Rapid Order Deep Link URL

Source: https://docs.upmind.com/docs/getting-started/ordering-1

This example demonstrates a complete rapid order URL, showing how the product and fields parameters are encoded after JSON stringification, ready for use in a browser or application.

```Text
https://{ YOUR_UPMIND_INSTANCE }/order/_?product=%257B%2522product_id%2522%3A%252201e96d29-8537-d4e5-025c-54e120637085%2522%2C%2522quantity%2522%3A1%2C%2522billing_cycle_months%2522%3A12%257D&fields=%257B%2522domain_name%2522%3A%2522example.com%2522%257D
```

--------------------------------

### Accessing Product Automation Settings

Source: https://docs.upmind.com/docs/getting-started/configure-subscription-automation

Provides a step-by-step guide to navigate the Upmind platform and access the product automation configuration page for subscriptions.

```APIDOC
Procedure:
  1. Log in to your account.
  2. Click Settings.
  3. On the next page, click Products & Services.
  4. Scroll down the Product catalogue page and click a subscription.
  5. Click the Product automation link.
```

--------------------------------

### Basekit API Credentials for Integration

Source: https://docs.upmind.com/docs/getting-started/how-to-integrate-and-sell-basekit

Details the required credentials for integrating Basekit, including their format and examples. These credentials are used for either on-premise or SAAS Basekit solutions.

```APIDOC
Credential Name | Format
--- | ---
API URL | e.g. `https://rest.bk-partnersus.com`
Username | A 32 character hexadecimal string
Password | A 32 character hexadecimal string
Brand Reference | Integer (e.g. 1234)
Suspension Package Reference | Integer (e.g. 1999)
Package References | For each package (e.g. 2000, 2001, 2002)
```

--------------------------------

### Example Web Hosting (cPanel) Welcome Email Template

Source: https://docs.upmind.com/docs/getting-started/how-to-create-hosting-welcome-emails

A generic email template for web hosting (cPanel) welcome emails, including dynamic fields for client, brand, contract, and server details, along with instructions for logging in, domain pointing, and email settings. This template uses a templating language similar to Jinja2 or Liquid.

```HTML/Templating
Dear {{ client.first_name }},<br ><br >

Thank you for ordering your new {{ brand.name }} hosting package. Your account is all set up and ready to go!<br ><br >

This email contains all the information you will need in order to get started.<br ><br >

<strong>Hosting account name:</strong> {{ contracts_product.product_name }}<br>
<strong>Domain:</strong> {{ contracts_product.service_identifier }} <br>
<strong>Server Hostname:</strong> {{ contracts_product.provision_field_values.data_server_hostname }}<br><br >

<strong>Getting Started</strong><br><br>

Your hosting package is now live. You can log in through your <a href="https://{{ brand.customer_portal_domain }}/products/{{ contracts_product.contract_id }}/{{ contracts_product.id }}/manage" target="_blank">client area</a> under Products & Services > {{ contracts_product.product_name }} ({{ contracts_product.service_identifier }}) > Login to Control Panel.<br><br>

You can also log into your control panel directly at:<br><br>

{% if contracts_product.provision_field_values.data_reseller %}
<strong>WHM Reseller login page:</strong> <a href="https://{{ contracts_product.provision_field_values.data_server_hostname }}/cpanel" target="_blank">https://{{ contracts_product.provision_field_values.data_server_hostname }}/whm</a><br>
{% else %}
<strong>Hosting login page:</strong> <a href="https://{{ contracts_product.provision_field_values.data_server_hostname }}/cpanel" target="_blank">https://{{ contracts_product.provision_field_values.data_server_hostname }}/cpanel</a><br>
{% endif %}

<strong>cPanel username:</strong> <strong>{{ contracts_product.provision_field_values.username }}</strong><br>
<strong>cPanel password:</strong> <em><a href="https://{{ brand.customer_portal_domain }}/products/{{ contracts_product.contract_id }}/{{ contracts_product.id }}/manage" target="_blank">Set your cPanel password via the {{ brand.name }} client area</a></em><br><br>

<strong>Your domain name</strong><br><br>

If you have requested a domain name during sign up, please keep in mind that your domain name may not be visible on the internet instantly. This process is called DNS propagation and can take up to 24 hours though usually just a few minutes. Until your domain has propagated, your website and email will not function. Once is has propagated, your domain name can also be used interchangably with {{ contracts_product.provision_field_values.data_server_hostname }}.<br><br>

<strong>Pointing External Domains</strong><br><br>

If your domain name is registered elsewhere, you need to update your domain nameservers to point it to your new hosting with us. Our nameservers are:<br><br>

{{ contracts_product.provision_field_values.data_ns1 }}<br >
{{ contracts_product.provision_field_values.data_ns2 }}<br >
{% if contracts_product.provision_field_values.data_ns3 %}{{ contracts_product.provision_field_values.data_ns3 }}<br >{% endif %}
{% if contracts_product.provision_field_values.data_ns4 %}{{ contracts_product.provision_field_values.data_ns4 }}<br >{% endif %}
<br>

Alternatively, you can update your A record to point to our server IP which you can find in your hosting panel under 'Shared service IP'.<br ><br >

Once your domain has propagated, you may also use https://www.{{ contracts_product.service_identifier }}/cpanel/<br><br >

The username and password above can be used with the hostname {{ contracts_product.provision_field_values.data_server_hostname }} or your domain ({{ contracts_product.service_identifier }}) for FTP or SSH. Your website files are stored within the public_html directory.<br><br>

<strong>Email Settings</strong><br><br >

Once you've logged into your hosting control panel you can create e-mail accounts under the 'Email Accounts' icon. You can then add them to your email program by using the following details:<br ><br >

Incoming Server Hostname: mail.{{ contracts_product.service_identifier }} (or {{ contracts_product.provision_field_values.data_server_hostname }})<br >
Incoming Server Port: 993<br >
Incoming Server Type: IMAP<br ><br >

Outgoing Server Hostname: mail.{{ contracts_product.service_identifier }} (or {{ contracts_product.provision_field_values.data_server_hostname }})<br >
Outgoing Server Port: 465<br ><br >
```

--------------------------------

### Configure Upmind Web Hosting Product with cPanel

Source: https://docs.upmind.com/docs/getting-started/sell-web-hosting

This guide outlines the process of setting up a new web hosting package in Upmind, configuring it to use cPanel as the provisioning provider, and linking it to an existing cPanel package identifier. It covers naming the product, setting provisioning details, and saving the configuration.

```Plaintext
1. In your Upmind admin area, navigate to `Host control` > `Web hosting`.
2. Click on the `Hosting packages` tab.
3. Click the `Add new` button to start configuring a new hosting package.
4. Give your product a name, then click Create.
5. Go to the product's Provisioning page.
6. Set the `Provision provider` to cPanel.
7. Set the `Package Identifier` provision field to match your cPanel package name.
8. In the `Provision providers` section, select cPanel, then click `Save`.
9. In the `Provision fields` section, click on `Package Identifier` and enter the cPanel package name that you obtained earlier, then click `Save`.
```

--------------------------------

### Configure Credit Limit at Brand Level

Source: https://docs.upmind.com/docs/getting-started/how-to-use-account-credit-limit

Step-by-step guide to enable and set global credit limit parameters for all clients under a brand, including permissible amount, currency, and statement generation day.

```APIDOC
Settings -> Payment Option -> Client Wallet:
  Enable/Disable Credit Limit: Toggle feature on/off.
  Credit Limit Permissible: Defines maximum negative wallet balance (uses Brand's default currency).
  Day of the Month for Generating Wallet Statements: Select day for automatic statement generation.
```

--------------------------------

### Create Hosting Packages in DirectAdmin for Upmind Integration

Source: https://docs.upmind.com/docs/getting-started/how-to-add-direct-admin-as-a-hosting-provider

Guide to creating a new hosting package within DirectAdmin, which will be used as a package identifier in Upmind. This process involves logging into DirectAdmin, managing user packages, and defining package limitations and names.

```Configuration Steps
1. Select Manage User Packages under the Account Manager option.
2. Then click Add Package in the right corner.
3. Specify the limitation, and set the package name, click Save.
```

--------------------------------

### Calculating Payments (USD Example)

Source: https://docs.upmind.com/docs/getting-started/invoice-reporting-for-accounts

Detailed logic for calculating payment amounts, especially when document and payment currencies differ. This includes handling various exchange rate scenarios and null values to determine the local amount paid.

```APIDOC
Steps:
- If invoice_paid_amount = 0, then Payment Amount is zero
- If Document Currency Code equals Payment Currency Code, Reported Payment Amount equals USD (Total / Net) Amount
- If Document Currency Code does not equal Payment Currency Code then:
  - If Payment Currency Exchange Rate = 1, then use:
    - Invoice_paid_amount as the amount
    - Payment Currency Code as the currency code from which to convert to USD using own exchange rates
  - If Payment Currency Exchange Rate does not equal 1 (and is not null) then:
    - Convert the total amount from brand currency back to the document currency code using the Currency Exchange Rate to reach the value / currency listed on the invoice
    - Take the product of this amount and the Payment Currency Exchange Rate to calculate the local amount paid by the customer in the Payment Currency Code
    - Convert this amount / code to USD using own exchange rate
  - If Payment Currency Exchange Rate is null then:
    - USD Payment Amount equals USD (Total) Amount
```

--------------------------------

### Upmind Notification Template Example

Source: https://docs.upmind.com/docs/getting-started/notifications-overview

This snippet demonstrates how variables are used within Upmind notification templates to dynamically insert event-specific data such as currency, amount, payment source, invoice number, and payment date. These templates are configurable for various hooks and allow for personalized messages.

```Upmind Template
We successfully received payment of {currency}{amount}
from your {payment source}
for invoice {invoice_number}
on {payment_date}
```

--------------------------------

### Retrieve Enhance Package Identifier

Source: https://docs.upmind.com/docs/getting-started/how-to-add-enhance-web-server

This guide explains how to locate the package identifier (either name or ID) in the Enhance control panel. This identifier is crucial for linking Enhance packages to Upmind products. It clarifies where to find both the package name and the package ID within the Enhance UI.

```APIDOC
Enhance Package Identifier Retrieval:
  Location: Enhance control panel > `Settings` > `Packages` (then click to edit a package)
  Identifiers:
    - Package Name: Found in the `Details` section (case sensitive)
    - Package ID: Found in the URL when editing the package (e.g., `.../packages/1` where '1' is the ID)
  Recommendation: Use package name if unique, otherwise use package ID.
```

--------------------------------

### Accessing Client and Ticket Properties in Twig Templates

Source: https://docs.upmind.com/docs/getting-started/how-to-get-email-notification-when-a-client-open-support-ticket

Examples of Twig syntax to correctly access specific client and ticket details within email templates, avoiding 'Array' output by specifying the desired property (e.g., full_name, email, body) instead of the object itself.

```Twig
{{ ticket.client.full_name }}
{{ ticket.client.first_name }}
{{ ticket.client.last_name }}
{{ ticket.client.email }}
{{ ticket.client.id }}
{{ ticket.client.ip_address }}
{{ ticket.client.location_ip }}
{{ client.support_pin }}
{{ ticket.first_message.body }}
```

--------------------------------

### Set Up Product Provisioning in Upmind

Source: https://docs.upmind.com/docs/getting-started/how-to-create-a-hostin-package

This section explains how to configure the provisioning settings for your Upmind product, directing orders to the appropriate reseller package and setting the configuration type.

```APIDOC
Provisioning:
1. Click the Provisioning menu tab.
2. In the new panel, click the field under the BLUEPRINT heading.
3. Select Web Hosting in the drop-down menu.
4. Uncheck the Provider box. (The default setting is checked.)
5. Click the Configuration field and select Static.
```

--------------------------------

### Activating Core Affiliate Program Features

Source: https://docs.upmind.com/docs/getting-started/creating-an-affiliate-system

Steps to activate the overall affiliate program, enable customer controls for self-management, and set the active life of the referral cookie.

```APIDOC
1. Click the Enabled toggle to the ON position to activate your affiliate program. If the toggle is on the OFF position, all of your affiliate payment systems are stopped.
2. Click the Customer Controls Enabled toggle to the ON position to let your customers create and manage their own affiliate program. If the toggle is OFF, only admins and staff can set up and configure your affiliate program.
3. Slide the scale to set the active life of the referral cookie.

NOTE: Upmind tracks client referrals through a unique link attached to a cookie. Each customer order gets tracked back to an affiliate through that link. You decide how long the cookie should remain active (i.e. the number of days after the cookie was first created).
```

--------------------------------

### Accessing Upmind Affiliates Page

Source: https://docs.upmind.com/docs/getting-started/creating-an-affiliate-system

Steps to navigate to the Affiliates configuration page within the Upmind dashboard to begin setting up or editing affiliate programs.

```APIDOC
1. Log in to your account.
2. Click Settings on the main dashboard.
3. Click the Affiliates tile under the e-commerce heading. The Affiliates page displays.
```

--------------------------------

### Create a Basic Product in Upmind

Source: https://docs.upmind.com/docs/getting-started/how-to-create-a-hostin-package

This section outlines the initial steps to create a new product entry in your Upmind account's product catalogue. It covers navigating to the product creation interface and entering basic product information.

```APIDOC
Creating a product:
1. Log in to your Upmind account.
2. Click Settings.
3. On the next page, click Product catalogue.
4. On the Product catalogue page, click Add new.
5. Click Product in the menu. A new panel displays.

Adding a product:
1. On the Add Product panel, click the category field.
2. Select shared hosting.
3. Click Single product.
4. Enter a unique product name.
5. Leave the boxes checked.
6. Add a product description. (optional)
7. Click Create. Upmind creates a basic product. Now it's time to add details, like billing and provisioning.
```

--------------------------------

### Insert Line Breaks in HTML Email Templates

Source: https://docs.upmind.com/docs/getting-started/how-to-format-email-templates

To create a line break within the body of an email template, use the HTML `<br />` tag. This tag forces the content following it to start on a new line, improving readability and formatting.

```HTML
<br />
```

--------------------------------

### Override Store Currency via URL Parameter

Source: https://docs.upmind.com/docs/getting-started/about-multi-currency

Demonstrates how to override the default store currency displayed to a client by appending a 'currency' GET variable to the store URL. This allows clients to view prices in a specific currency regardless of the default store or client settings.

```APIDOC
https://shop.brand.com/order/shop?currency=USD
```

--------------------------------

### Calculate Customer Lifetime Value (LTV) Formula

Source: https://docs.upmind.com/docs/getting-started/what-is-customer-lifetime-value-ltv

This formula demonstrates how to calculate Customer Lifetime Value (LTV) by incorporating Average Revenue Per User (ARPU), Gross Margin, and Churn Rate. The example illustrates a typical calculation with sample values.

```Formula
LTV = (ARPU * Gross Margin) / Churn Rate
LTV = ($100 x 40%) / 10%
LTV = $400
```

--------------------------------

### Configure Upmind Hosting Products with Enhance

Source: https://docs.upmind.com/docs/getting-started/how-to-add-enhance-web-server

This snippet details the process of setting up a new hosting package in Upmind and associating it with an Enhance provision provider. It specifies how to select Enhance as the provider and input the correct Package Identifier (name or ID) obtained from Enhance.

```APIDOC
Upmind Product Configuration:
  Navigation: Upmind admin area > `Host control` > `Web hosting` tab > `Hosting packages` > `Add new`
  Steps:
    1. Give your product a name, then click `Create`.
    2. Go to the product's `Provisioning` page.
    3. In `Provision providers` section, select `Enhance`.
    4. Click `Save`.
    5. In `Provision fields` section, click on `Package Identifier`.
    6. Enter the Enhance package `name` or `id` (obtained earlier).
    7. Click `Save`.
  Result: Enhance product provisioning is set up.
```

--------------------------------

### Setting General Affiliate Redirect URL

Source: https://docs.upmind.com/docs/getting-started/creating-an-affiliate-system

Instructions to enter the URL where affiliate referrals will be redirected after clicking an affiliate link.

```APIDOC
Enter a URL for your redirect destination.
```

--------------------------------

### Configure Product Billing in Upmind

Source: https://docs.upmind.com/docs/getting-started/how-to-create-a-hostin-package

This section details how to set up the billing aspects for your Upmind product, specifically configuring recurring payment terms and defining the billing period and total amount.

```APIDOC
Product billing:
1. Click the Product billing menu tab.
2. Next to the Product type heading, click the Recurring payment tile.
3. In the Subscription Terms section, click Add new term.
4. Select a period in the drop-down menu. In this example, we select monthly.
5. Enter a billing total in the blank field.
6. Click Save.
```

--------------------------------

### Initiating Affiliate Tier Creation

Source: https://docs.upmind.com/docs/getting-started/creating-an-affiliate-system

Instructions to begin creating a new, unique affiliate program tier from the Affiliates page. Note that detailed tier configuration is covered in a separate article.

```APIDOC
At the top of the Affiliates page, click the Add affiliate tier button to create a unique affiliate program.
```

--------------------------------

### Upmind Notification Template Example

Source: https://docs.upmind.com/docs/getting-started/notifications

This code snippet illustrates the use of variables within Upmind's notification templates. These variables, enclosed in curly braces, are dynamically replaced with event-specific data (e.g., currency, amount, invoice details) when a notification is generated, allowing for personalized messages.

```Templating Syntax
We successfully received payment of {currency}{amount}
from your {payment source}
for invoice {invoice_number}
on {payment_date}
```

--------------------------------

### Link Direct Admin Server to Upmind Provision Configuration

Source: https://docs.upmind.com/docs/getting-started/how-to-add-direct-admin-as-a-hosting-provider

Steps to add a DirectAdmin server as a new provision configuration within Upmind, enabling it to manage hosting products. This involves navigating to the Web Servers or Provision Configurations section in Upmind and entering the DirectAdmin server details.

```Configuration Steps
On the sidebar click Host Control > Web Servers > Add New
On the sidebar go to Settings > Provision Configurations > Add New
1. Fill in the name of your server
2. Choose the provision category
3. Choose Direct Admin as a provider
4. Enter the hostname, username, and password. This is the same as your DirectAdmin username and password.
5. Click Create
```

--------------------------------

### Creating Automated Email Spam Rules in Upmind

Source: https://docs.upmind.com/docs/getting-started/how-to-manage-spam-tickets

This guide explains how to set up new automated email spam rules in Upmind. These rules are applied to incoming pipe emails and automatically flag emails as spam if they match specified conditions. Conditions can be based on client, lead, subject keywords, or specific email addresses.

```APIDOC
To Create a New Spam Rule:
1. Click "Create Email Spam Rule".
2. Adjust your spam rules to fit your preferences easily.
3. You can use different conditions such as:
   * Client: Block emails from specific clients. When you block a client, all email addresses associated with that client will be flagged as spam.
   * Lead: Block emails from specific leads. Similar to clients, blocking a lead will flag all associated email addresses as spam.
   * Subject: Block emails based on keywords in the subject line. Add keywords or phrases that, if present in the subject line, will flag the email as spam.
   * Email Address: Block specific email addresses. Enter the email addresses you want to block.
4. Click create.
```

--------------------------------

### Linode Server Type IDs and Specifications

Source: https://docs.upmind.com/docs/getting-started/how-to-add-linode-products

Details the Linode Types available, providing their Type IDs, Labels, and hardware specifications (CPU, RAM, Disk) for configuring the Server Size field in Upmind.

```APIDOC
Linode Type ID: g6-nanode-1, Linode Type Label: Nanode 1GB, Specs: 1 CPU Core, 1 GB RAM, 25 GB Disk
Linode Type ID: g6-standard-1, Linode Type Label: Linode 2GB, Specs: 1 CPU Cores, 2 GB RAM, 50 GB Disk
Linode Type ID: g6-standard-2, Linode Type Label: Linode 4GB, Specs: 2 CPU Cores, 4 GB RAM, 80 GB Disk
Linode Type ID: g6-standard-4, Linode Type Label: Linode 8GB, Specs: 4 CPU Cores, 8 GB RAM, 160 GB Disk
Linode Type ID: g6-standard-6, Linode Type Label: Linode 16GB, Specs: 6 CPU Cores, 16 GB RAM, 320 GB Disk
Linode Type ID: g6-standard-8, Linode Type Label: Linode 32GB, Specs: 8 CPU Cores, 32 GB RAM, 640 GB Disk
Linode Type ID: g6-standard-16, Linode Type Label: Linode 64GB, Specs: 16 CPU Cores, 64 GB RAM, 1.2 TB Disk
Linode Type ID: g6-standard-20, Linode Type Label: Linode 96GB, Specs: 20 CPU Cores, 96 GB RAM, 1.9 TB Disk
Linode Type ID: g6-standard-24, Linode Type Label: Linode 128GB, Specs: 24 CPU Cores, 128 GB RAM, 2.5 TB Disk
Linode Type ID: g6-standard-32, Linode Type Label: Linode 192GB, Specs: 32 CPU Cores, 192 GB RAM, 3.8 TB Disk
Linode Type ID: g7-highmem-1, Linode Type Label: Linode 24GB, Specs: 2 CPU Cores, 24 GB RAM, 20 GB Disk
Linode Type ID: g7-highmem-2, Linode Type Label: Linode 48GB, Specs: 2 CPU Cores, 48 GB RAM, 40 GB Disk
Linode Type ID: g7-highmem-4, Linode Type Label: Linode 90GB, Specs: 4 CPU Cores 90 GB RAM, 90 GB Disk
Linode Type ID: g7-highmem-8, Linode Type Label: Linode 150GB, Specs: 8 CPU Cores, 150 GB RAM, 200 GB Disk
Linode Type ID: g7-highmem-16, Linode Type Label: Linode 300GB, Specs: 16 CPU Cores, 300 GB RAM, 340 GB Disk
Linode Type ID: g6-dedicated-2, Linode Type Label: Dedicated 4GB, Specs: 2 CPU Cores, 4 GB RAM, 80 GB Disk
Linode Type ID: g6-dedicated-4, Linode Type Label: Dedicated 8GB, Specs: 4 CPU Cores, 8 GB RAM, 160 GB Disk
Linode Type ID: g6-dedicated-8, Linode Type Label: Dedicated 16GB, Specs: 8 CPU Cores, 16 GB RAM, 320 GB Disk
Linode Type ID: g6-dedicated-16, Linode Type Label: Dedicated 32GB, Specs: 16 CPU Cores, 32 GB RAM, 640 GB Disk
Linode Type ID: g6-dedicated-32, Linode Type Label: Dedicated 64GB, Specs: 32 CPU Cores, 64 GB RAM, 1.2 TB Disk
Linode Type ID: g6-dedicated-48, Linode Type Label: Dedicated 96GB, Specs: 48 CPU Cores, 96 GB RAM, 1.9 TB Disk
Linode Type ID: g6-dedicated-50, Linode Type Label: Dedicated 128GB, Specs: 50 CPU Cores, 128 GB RAM, 2.4 TB Disk
Linode Type ID: g6-dedicated-56, Linode Type Label: Dedicated 256GB, Specs: 56 CPU Cores, 256 GB RAM, 4.9 TB Disk
Linode Type ID: g6-dedicated-64, Linode Type Label: Dedicated 512GB, Specs: 64 CPU Cores, 512 GB RAM, 7 TB Disk
Linode Type ID: g1-gpu-rtx6000-1, Linode Type Label: Dedicated 32GB + RTX6000 GPU x1, Specs: 8 CPU Cores, 1 GPU Cores, 32 GB RAM, 640 GB Disk
Linode Type ID: g1-gpu-rtx6000-2, Linode Type Label: Dedicated 64GB + RTX6000 GPU x2, Specs: 16 CPU Cores, 2 GPU Cores, 64 GB RAM, 1.2 TB Disk
Linode Type ID: g1-gpu-rtx6000-3, Linode Type Label: Dedicated 96GB + RTX6000 GPU x3, Specs: 20 CPU Cores, 3 GPU Cores, 96 GB RAM, 1.9 TB Disk
Linode Type ID: g1-gpu-rtx6000-4, Linode Type Label: Dedicated 128GB + RTX6000 GPU x4, Specs: 24 CPU Cores, 4 GPU Cores, 128 GB RAM, 2.5 TB Disk
```

--------------------------------

### Configure General Affiliate Program Settings

Source: https://docs.upmind.com/docs/getting-started/affiliates

Explains how to activate the Upmind affiliate program, enable customer controls, and set the active life of referral cookies. These settings control the overall behavior and accessibility of the affiliate system.

```APIDOC
General Affiliate Settings:
  Enabled: boolean
    Description: Activates or deactivates the entire affiliate program.
    Values: ON (active), OFF (stopped)
  Customer Controls Enabled: boolean
    Description: Allows customers to create and manage their own affiliate programs.
    Values: ON (customers can manage), OFF (only admins/staff can manage)
  Referral Cookie Active Life: integer (days)
    Description: Sets the duration (in days) for which a referral cookie remains active.
    Default: (slide scale value)
    Note: Upmind tracks client referrals through a unique link attached to a cookie. Each customer order gets tracked back to an affiliate through that link.
```

--------------------------------

### Create GA4 and Upmind Event Tags in Google Tag Manager

Source: https://docs.upmind.com/docs/getting-started/supported-event-types

This snippet details the Google Analytics 4 (GA4) event tags recommended by Upmind for configuration in Google Tag Manager. Each tag is associated with a specific firing trigger to ensure accurate data collection for e-commerce and first-party events in GA4.

```APIDOC
Google Tag Manager Tags Configuration:
- GA4 Event 'add_payment_info': Type: Google Analytics: GA4 Event, Firing Trigger: GA4 add_payment_info
- GA4 Event 'add_to_cart': Type: Google Analytics: GA4 Event, Firing Trigger: GA4 add_to_cart
- GA4 Event 'login': Type: Google Analytics: GA4 Event, Firing Trigger: GA4 login
- GA4 Event 'purchase': Type: Google Analytics: GA4 Event, Firing Trigger: GA4 purchase
- GA4 Event 'sign_up': Type: Google Analytics: GA4 Event, Firing Trigger: GA4 sign_up
- GA4 Event 'view_item': Type: Google Analytics: GA4 Event, Firing Trigger: GA4 view_item
- GA4 Event 'remove_from_cart': Type: Google Analytics: GA4 Event, Firing Trigger: GA4 remove_from_cart
- UPM Event 'upm_actor_identified': Type: Google Analytics: GA4 Event, Firing Trigger: UPM actor_identified
- UPM Event 'upm_logout': Type: Google Analytics: GA4 Event, Firing Trigger: UPM logout
- UPM Event 'upm_modal_open': Type: Google Analytics: GA4 Event, Firing Trigger: UPM modal_open
```

--------------------------------

### Configure GA4 and Upmind Custom Event Triggers in Google Tag Manager

Source: https://docs.upmind.com/docs/getting-started/supported-event-types

This snippet outlines the custom event triggers recommended by Upmind for Google Tag Manager to capture various e-commerce and first-party events for Google Analytics 4 (GA4) tracking. These triggers are essential for firing GA4 event tags based on specific user interactions.

```APIDOC
Google Tag Manager Triggers Configuration:
- GA4 add_payment_info: Custom Event
- GA4 add_to_cart: Custom Event
- GA4 login: Custom Event
- GA4 purchase: Custom Event
- GA4 remove_from_cart: Custom Event
- GA4 sign_up: Custom Event
- GA4 view_item: Custom Event
- UPM actor_identified: Custom Event
- UPM logout: Custom Event
- UPM modal_open: Custom Event
```

--------------------------------

### Create a New Package in WHM

Source: https://docs.upmind.com/docs/getting-started/how-to-create-a-hostin-package

This section provides instructions for creating a new hosting package directly within your WHM account. This package will later be mapped to an Upmind product.

```APIDOC
WHM Package name:
1. Log in to your WHM account.
2. On the left menu, expand the Packages folder.
3. Click Add Package.
4. Enter a unique name.
5. Scroll through the list and the options that apply.
6. Click Add.
```

--------------------------------

### Troubleshooting Common cPanel Errors in Upmind

Source: https://docs.upmind.com/docs/getting-started/sell-web-hosting

This section details common errors that may occur when integrating cPanel with Upmind, providing concise explanations for each error and actionable solutions to resolve them quickly. It covers issues related to access, package names, and user sessions.

```APIDOC
Error: Create Account: Forbidden Access Denied
  Description: Indicates an issue with authentication or authorization.
  Solution: Ensure the hostname, username, and API key are entered correctly in Settings → Provision configurations.

Error: "xxxx" is not a valid package name, at /usr/local/Whostmg
  Description: The package identifier in Upmind does not match a valid package in cPanel's Web Host Manager.
  Solution: Create a package in your Web Host Manager interface, and ensure this matches the package identifier entered in Settings → Product Catalogue → [Product] → Provisioning → Package Identifier in Upmind.

Error: You cannot create a session for the user 'xxx' because they do not exist
  Description: The cPanel account username provided is incorrect or the account does not exist on the server.
  Solution: Verify the cPanel account username or confirm the account's existence on the server.
```

--------------------------------

### Configuring Affiliate Payout Destinations

Source: https://docs.upmind.com/docs/getting-started/creating-an-affiliate-system

Detailed steps to add and configure various payout destinations for affiliate commissions, including Wallet, Offline, and PayPal options. You can set a default method and control client visibility.

```APIDOC
1. Click the Add payout destination button. A new panel displays.
2. On the new panel, enter a unique name for this payment method.
3. Click the drop-down menu and select an option (Wallet, Offline, or Paypal).
4. Check the box to make this the default payout method. (optional)
5. Uncheck the box to hide this information from clients. (optional) The default is Visible for clients.
6. Repeat steps to add another payment method. (optional)

NOTE: If you choose PayPal, you need to enter a payment gateway of type PayPal (REST).
NOTE: To bank wire commissions, your affiliate should open a ticket and send bank transfer details (e.g. Swift code).
```

--------------------------------

### Link Enhance to Upmind Provision Configuration

Source: https://docs.upmind.com/docs/getting-started/how-to-add-enhance-web-server

This snippet outlines the steps to add Enhance as a provision configuration in Upmind. It provides two navigation paths within Upmind and details the necessary fields to fill, including server name, provision category, hostname, org ID, and access token.

```APIDOC
Upmind Provision Configuration:
  Navigation Paths:
    1. Sidebar: `Host Control` > `Web Servers` > `Add New`
    2. Sidebar: `Settings` > `Provision Configurations` > `Add New`
  Configuration Fields:
    1. Server Name: Descriptive name for your server
    2. Provision Category: `Web Hosting`
    3. Hosting Panel Type: `Enhance`
    4. Hostname: Your Enhance server's hostname
    5. Org ID: The org-id obtained from Enhance
    6. Access Token: The access token obtained from Enhance
  Action: Click `Create`
```

--------------------------------

### Linode Server Type IDs and Specifications for Upmind Configuration

Source: https://docs.upmind.com/docs/getting-started/servers

This table provides a comprehensive list of Linode Type IDs, their labels, and detailed specifications (CPU, RAM, Disk). These IDs are entered into the 'Server Size' field in Upmind to define the hardware resources for new Linodes.

```APIDOC
Linode Type ID | Linode Type Label | Specs
--- | --- | ---
g6-nanode-1 | Nanode 1GB | 1 CPU Core, 1 GB RAM, 25 GB Disk
g6-standard-1 | Linode 2GB | 1 CPU Cores, 2 GB RAM, 50 GB Disk
g6-standard-2 | Linode 4GB | 2 CPU Cores, 4 GB RAM, 80 GB Disk
g6-standard-4 | Linode 8GB | 4 CPU Cores, 8 GB RAM, 160 GB Disk
g6-standard-6 | Linode 16GB | 6 CPU Cores, 16 GB RAM, 320 GB Disk
g6-standard-8 | Linode 32GB | 8 CPU Cores, 32 GB RAM, 640 GB Disk
g6-standard-16 | Linode 64GB | 16 CPU Cores, 64 GB RAM, 1.2 TB Disk
g6-standard-20 | Linode 96GB | 20 CPU Cores, 96 GB RAM, 1.9 TB Disk
g6-standard-24 | Linode 128GB | 24 CPU Cores, 128 GB RAM, 2.5 TB Disk
g6-standard-32 | Linode 192GB | 32 CPU Cores, 192 GB RAM, 3.8 TB Disk
g7-highmem-1 | Linode 24GB | 2 CPU Cores, 24 GB RAM, 20 GB Disk
g7-highmem-2 | Linode 48GB | 2 CPU Cores, 48 GB RAM, 40 GB Disk
g7-highmem-4 | Linode 90GB | 4 CPU Cores 90 GB RAM, 90 GB Disk
g7-highmem-8 | Linode 150GB | 8 CPU Cores, 150 GB RAM, 200 GB Disk
g7-highmem-16 | Linode 300GB | 16 CPU Cores, 300 GB RAM, 340 GB Disk
g6-dedicated-2 | Dedicated 4GB | 2 CPU Cores, 4 GB RAM, 80 GB Disk
g6-dedicated-4 | Dedicated 8GB | 4 CPU Cores, 8 GB RAM, 160 GB Disk
g6-dedicated-8 | Dedicated 16GB | 8 CPU Cores, 16 GB RAM, 320 GB Disk
g6-dedicated-16 | Dedicated 32GB | 16 CPU Cores, 32 GB RAM, 640 GB Disk
g6-dedicated-32 | Dedicated 64GB | 32 CPU Cores, 64 GB RAM, 1.2 TB Disk
g6-dedicated-48 | Dedicated 96GB | 48 CPU Cores, 96 GB RAM, 1.9 TB Disk
g6-dedicated-50 | Dedicated 128GB | 50 CPU Cores, 128 GB RAM, 2.4 TB Disk
g6-dedicated-56 | Dedicated 256GB | 56 CPU Cores, 256 GB RAM, 4.9 TB Disk
g6-dedicated-64 | Dedicated 512GB | 64 CPU Cores, 512 GB RAM, 7 TB Disk
g1-gpu-rtx6000-1 | Dedicated 32GB + RTX6000 GPU x1 | 8 CPU Cores, 1 GPU Cores, 32 GB RAM, 640 GB Disk
g1-gpu-rtx6000-2 | Dedicated 64GB + RTX6000 GPU x2 | 16 CPU Cores, 2 GPU Cores, 64 GB RAM, 1.2 TB Disk
g1-gpu-rtx6000-3 | Dedicated 96GB + RTX6000 GPU x3 | 20 CPU Cores, 3 GPU Cores, 96 GB RAM, 1.9 TB Disk
g1-gpu-rtx6000-4 | Dedicated 128GB + RTX6000 GPU x4 | 24 CPU Cores, 4 GPU Cores, 128 GB RAM, 2.5 TB Disk
```

--------------------------------

### Map Upmind Product to WHM Package Identifier

Source: https://docs.upmind.com/docs/getting-started/how-to-create-a-hostin-package

This crucial step involves linking your Upmind product to a specific WHM package by configuring the Package Identifier field within Upmind's provisioning settings. This ensures orders are correctly sent to your WHM reseller account.

```APIDOC
Package Mapping:
1. Click Package Identifier.
2. On the next page, check the box next to the Upmind hosting package.
3. Paste the name of the WHM package you are mapping.
4. Click Save.
```

--------------------------------

### Basekit API Credentials for Upmind Integration

Source: https://docs.upmind.com/docs/getting-started/website-builders

This section outlines the necessary credentials required to integrate Basekit with Upmind. It includes details on the API URL, authentication details (Username, Password), and various reference IDs for branding and package management.

```APIDOC
Basekit Credentials:
- API URL: e.g. https://rest.bk-partnersus.com
- Username: A 32 character hexadecimal string
- Password: A 32 character hexadecimal string
- Brand Reference: Integer (e.g. 1234)
- Suspension Package Reference: Integer (e.g. 1999)
- Package References: For each package (e.g. 2000, 2001, 2002)
```

--------------------------------

### Download PDF Credit Statements from Client Area

Source: https://docs.upmind.com/docs/getting-started/how-to-use-account-credit-limit

Steps for clients to download their own credit statements in PDF format from their client area.

```APIDOC
Client Area -> Billing -> Account Credit:
  1. Click View Credit Statements.
  2. Select the statement you want.
  3. Click the "PDF icon" button to download it.
```

--------------------------------

### JavaScript Utility to Format Rapid Order Query Parameters

Source: https://docs.upmind.com/docs/getting-started/ordering-1

This IIFE (Immediately Invoked Function Expression) provides a utility to correctly format and encode query parameters for the rapid order route. It ensures that object-type parameters like 'product' and 'fields' are first JSON stringified and then URI encoded, returning a ready-to-use query string.

```JavaScript
((params, host = "?") => {
  for (const key in params) {
    if (typeof params[key] === "object")
      params[key] = encodeURI(JSON.stringify(params[key]));
  }
  return host + new URLSearchParams(params).toString();
})({
  product: { ... },
  fields: { ... },
  currency: "USD",
});
```

--------------------------------

### Payment Gateway Settings Configuration

Source: https://docs.upmind.com/docs/getting-started/payment-options-overview

Customise how Upmind handles automatic payments, including payment capture mode, authorization delays, partial payments, statement descriptions, and card storage options.

```APIDOC
Gateway Settings:
  Payment capture mode:
    Description: This setting controls whether card payments are captured immediately or just authorized for later capture. Immediate capture is useful to avoid chargebacks from fraudulent payments.
    Options:
      Direct Capture: Payment is taken right away.
      Authorize: Payment is pre-approved and reserved on the customer’s card, allowing you to complete the charge later.
  Authorization capture delay days:
    Description: Set how many days after authorization the payment should be captured (applies if using Authorize mode).
  Enable partial payments for clients:
    Description: Allow clients to pay invoices in parts, not just in full.
  Statement description:
    Description: Set a description to appear on client statements (if supported by the payment processor).
  Force card storage:
    Description: Store card details securely for future use, if supported by the gateway.
  Delete card only if replacement:
    Description: Only remove a stored card if a new one is added and the account has active services.
  Force auto payment for stored details:
    Description: Automatically charge invoices using stored payment details.
  Enable payment details store for shared invoices:
    Description: Show *Save payment details* and *Allow auto payment options* for shared invoices.
```

--------------------------------

### Format Rapid Order Parameters for URL

Source: https://docs.upmind.com/docs/getting-started/place-a-rapid-order-experimental

This JavaScript Immediately Invoked Function Expression (IIFE) helps format product and field objects for the rapid order route. It ensures that object-type parameters are first JSON.stringify'd and then URI encoded, returning a correctly formatted query string for the URL.

```JavaScript
((params, host = "?") => {
  for (const key in params) {
    if (typeof params[key] === "object")
      params[key] = encodeURI(JSON.stringify(params[key]));
  }
  return host + new URLSearchParams(params).toString();
})({
  product: { ... },
  fields: { ... },
  currency: "USD",
});
```

--------------------------------

### Configure Default Order Template in Upmind Settings

Source: https://docs.upmind.com/docs/getting-started/how-to-use-order-templates

This section details the configuration options available in the Upmind administrative settings under 'settings > order options' to automatically create an order for every new client. It describes fields like 'Signup order on' and 'Sigup order default template ID'.

```APIDOC
Field name: Signup order on
  Description: This defines when the order is placed in the client account.
  Values:
    - Registration: when the client fills out the registration form.
    - Verification: once they have verified their email.

Field name: Sigup order default template ID
  Description: If you want to auto-create an order for every new client, the code of that order (e.g. myexampleorder)
```

--------------------------------

### Download PDF Credit Statements from Admin Area

Source: https://docs.upmind.com/docs/getting-started/how-to-use-account-credit-limit

Steps for administrators to download client credit statements in PDF format from the admin interface.

```APIDOC
Admin Area -> Account Credit section:
  1. Click View Credit Statements.
  2. Select the statement you want.
  3. Click the "PDF icon" button to download it.
```

--------------------------------

### Copy Existing WHM Package Name

Source: https://docs.upmind.com/docs/getting-started/how-to-create-a-hostin-package

This section details how to retrieve the exact name of an existing WHM package, which is necessary for accurately mapping it to an Upmind product's Package Identifier field.

```APIDOC
Copying package name:
1. On the left menu, click Edit.
2. In the list of options, select the package you want to map to Upmind.
3. Click Edit.
4. In the new window, copy the package name.
5. Go to the Upmind page and paste the name into the Package Identifier field.
```

--------------------------------

### Client View of Credit Limits

Source: https://docs.upmind.com/docs/getting-started/how-to-use-account-credit-limit

Explains how clients access and use their credit limit within the client area, noting that the first currency used for credit limit payments dictates subsequent payments.

```APIDOC
Client Area -> Billing -> Account Credit -> Credit Limit:
  Clients can use the credit limit within their preferred currency.
  Currency Restriction: If a client uses their credit limit in one currency for the first payment, all future payments using the credit limit must be in the same currency (e.g., USD for first payment means USD for all future credit limit payments).
```

--------------------------------

### Customizing Affiliate Commission Period and Invoice Rules

Source: https://docs.upmind.com/docs/getting-started/creating-an-affiliate-system

Steps to define the duration for commission payouts (in months) and set rules for whether commissions are paid on paid invoices only, or also on unpaid or free invoices.

```APIDOC
You can decide how long to pay referring agent commissions. Leave the default (zero) if you will pay commissions forever. Otherwise, enter a number to set the period length (in months).

Only on paid invoices:
The default setting is Yes. That means you only pay commissions on paid invoices. If the toggle is set to No, you pay commissions on unpaid invoices.

Commission on free invoices:
The default setting is Yes. That means you pay commissions on paid invoices that generate no revenue. (e.g. you pay a fixed amount for an invoice rather than a percentage of the total invoiced amount). If the toggle is set to No, you do not pay commissions on free invoices.
```

--------------------------------

### Payment Currency Settings Fields

Source: https://docs.upmind.com/docs/getting-started/payment-options-overview

Describes the configurable fields for managing how invoices and payments are handled across multiple currencies.

```APIDOC
Payment Currency Settings:
  Enable payment in different than document currency: Let clients choose a preferred payment currency per payment, not just per invoice.
```
Tokens:
Raw