> ## Documentation Index
> Fetch the complete documentation index at: https://docs.skyfree.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Whitelabel Plans

> Create and manage the pricing plans your whitelabel customers buy.

<Info>
  **Requires the White-Label add-on.** This page is part of the White-Label add-on, which lets you create and sell white-label platforms to your own customers. Without the add-on, it doesn't appear in the Instance menu. See the [Self-Hosted overview](/self-host/overview) to compare the two levels, and check [Licence](/self-host/whitelabel-setup/licence-status) to see what your instance includes. It also requires the `instance:view` permission.
</Info>

## What is this?

**Whitelabel Plans** is where you define the pricing catalog that platform owners on your white-label instance can buy or be billed against — setup plans, credit packs, wallet recharge packs, add-ons, and the default commission terms.

<img src="https://mintcdn.com/mail2skyfreegmailcom/TMRlP9xN8aYGfnKu/images/whitelabel-plans-tabs.png?fit=max&auto=format&n=TMRlP9xN8aYGfnKu&q=85&s=125df9dd5e07e0626cb3a8a2f69314d5" alt="Whitelabel Plans page showing the stat tiles and the Setup / Credits / Wallet / Add-Ons / Commission tab bar" width="1282" height="953" data-path="images/whitelabel-plans-tabs.png" />

## What can I do here?

* View summary tiles: **Setup Plans**, **Credit Packs**, **Add-Ons**, and **Active Catalog Value**
* Switch between five tabs: **Setup**, **Credits**, **Wallet**, **Add-Ons**, and **Commission**
* Search pricing rows by key, label, or category
* Add a new pricing row, or edit/delete an existing one, for any category
* Sync your pricing catalog to an active payment gateway provider (single click if one gateway is active, or choose which provider to sync to if more than one is active)
* View and update the default **Commission** settings used for commission-billed platforms

## How to use it

Open **Platform → Instance → Whitelabel Plans** and choose a tab. Each of the first four tabs holds one category of pricing rows.

<Tabs>
  <Tab title="Setup">
    Setup plans — the one-time purchase a platform owner makes to get started. Setup plans are always **One-time**, and can include **Credits Included**.
  </Tab>

  <Tab title="Credits">
    Credit packs that platform owners buy. These can include **Credits Included**.
  </Tab>

  <Tab title="Wallet">
    Wallet recharge packs, for platforms billed through a wallet.
  </Tab>

  <Tab title="Add-Ons">
    Add-ons that platform owners can buy on top of their plan. Each add-on row has an **Addon Key** — pick a known key such as `android_app`, `ios_app`, `storage`, `priority_support`, or `custom_integrations`, or type a custom one.
  </Tab>

  <Tab title="Commission">
    The default commission terms used for commission-billed platforms: **Default Commission %**, **Min Monthly Commission**, and **Min Wallet Balance**. See "Set default commission terms" below.

    <img src="https://mintcdn.com/mail2skyfreegmailcom/OO2U_FWAO_6BJhiB/images/whitelabel-plans-commission-tab.png?fit=max&auto=format&n=OO2U_FWAO_6BJhiB&q=85&s=1a0dffff028eaa2a85c67ccd18c867e7" alt="Commission tab with the default commission percentage and minimum balance fields" width="1282" height="953" data-path="images/whitelabel-plans-commission-tab.png" />
  </Tab>
</Tabs>

### Add a pricing row

1. Open the tab for the category you want (**Setup**, **Credits**, **Wallet**, or **Add-Ons**).
2. Click **Add Pricing**.
3. Fill in the pricing form:
   * **Label** and, for Add-Ons, an **Addon Key** (pick a known key such as `android_app`, `ios_app`, `storage`, `priority_support`, `custom_integrations`, or type a custom one)
   * **Category** and **Billing Mode** (One-time or Recurring — Setup plans are always one-time)
   * **Amount**, **Description**, **Sort Order**
   * **Credits Included** (Setup and Credits categories only)
   * **Validity Period** (Monthly, Quarterly, Half-Yearly, or Yearly)
   * **Provider Plan IDs** as a JSON object, for mapping this plan to payment-gateway-specific plan IDs
   * An **Active** toggle
4. Click **Save**.

<img src="https://mintcdn.com/mail2skyfreegmailcom/TMRlP9xN8aYGfnKu/images/whitelabel-plans-add-dialog.png?fit=max&auto=format&n=TMRlP9xN8aYGfnKu&q=85&s=c2e18da3d05b4aad8978d28e179eb027" alt="Add Pricing dialog showing the label, category, billing mode, amount, credits included, and validity period fields" width="1282" height="953" data-path="images/whitelabel-plans-add-dialog.png" />

### Edit or remove a pricing row

1. In the pricing table, click the **pencil icon** on a row to edit it, or the **trash icon** to delete it.
2. Deleting a row saves the updated catalog immediately.

### Sync pricing to your payment gateway

1. In the toolbar, select a provider if more than one payment gateway is active.
2. Click **Sync Provider Library** to push all pricing rows to that gateway as a background job. A toast confirms when the sync completes, with a success/fail count.
3. To sync a single row's provider plan ID after editing it, open that row for editing, choose a provider under **Sync Provider IDs**, and click **Sync Provider IDs**.

<img src="https://mintcdn.com/mail2skyfreegmailcom/OO2U_FWAO_6BJhiB/images/whitelabel-plans-sync-toolbar.png?fit=max&auto=format&n=OO2U_FWAO_6BJhiB&q=85&s=cf17129779521dcfc112c0e66aecc6e6" alt="Toolbar showing the provider selector and Sync Provider Library button" width="1282" height="953" data-path="images/whitelabel-plans-sync-toolbar.png" />

### Set default commission terms

1. Open the **Commission** tab.
2. Set **Default Commission %**, **Min Monthly Commission**, and **Min Wallet Balance**.
3. Click **Save Commission Settings**. These defaults apply to platforms billed under the Commission mode (see [Whitelabel Users](/self-host/whitelabel-users)).

## Troubleshooting / Technical Notes

* **Save is rejected.** The message names the exact rule that failed. Common causes:

  * A row is missing a **Label** or has an invalid **Category** ("Each pricing row must include a label and valid category.")
  * A row's **Amount** isn't a number greater than zero
  * Two rows share the same **key** ("Duplicate pricing key found" or "Pricing key already exists")
  * The **Provider Plan IDs** field isn't valid JSON ("Provider IDs must be a JSON object.")

  Read the message, fix the row — usually the key, label, or amount — and save again.
* **Credits Included disappears.** It's only kept for **Setup** and **Credits** categories, and resets to 0 for Wallet and Add-On rows. It has no meaning for those categories.
* **"Sync Provider IDs" is missing on a new row.** It only appears for rows that are already saved. Save the new row first, then re-open it — **Sync Provider IDs** now appears.
* **A customer can't be billed for a mobile app build or credit-line add-on.** The **Addon Key** picker suggests `whatsapp_credit_line`, `android_app`, and `ios_app` as "(Required)", but nothing checks that those keys exist or stay active. Make sure an active add-on row exists with the exact key. [Whitelabel App Generation](/self-host/whitelabel-app-generation) and the assign dialogs on [Whitelabel Users](/self-host/whitelabel-users) only use active add-on rows.
