> For the complete documentation index, see [llms.txt](https://docs.brigge.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.brigge.ai/documentation/account-and-plans/brigge-subscriptions-and-tokens.md).

# Brigge subscriptions & tokens

## Introduction

Brigge runs on a token-based system. When you [register for a Brigge account](/documentation/account-and-plans/brigge-registration.md), you receive 1,000 tokens to get started, with full access to the platform. When you're ready to go further, you can move to a [paid subscription](#how-do-subscription-allowances-work) - monthly and annual plans are available to suit different business sizes.&#x20;

If you need flexibility beyond your plan's allowance, you can add an [overage plan](#how-do-overages-work). This provides additional tokens that can be used as a buffer if your subscription allowance is exceeded.

## How do subscription allowances work?

When you purchase a subscription plan, you receive a monthly token allowance. Subscription plans run on calendar months. If you subscribe part-way through a month, your payment amount and token allowance are pro-rated accordingly.&#x20;

{% hint style="info" %}
Unused tokens do not roll over; token allowances reset with each billing cycle.&#x20;
{% endhint %}

<details>

<summary>Adding a payment method</summary>

From the navigation menu, select `settings` ➥ `billing management` ➥ `billing information`, then follow on-screen instructions to add a new payment method:

<div data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FnXS5Qx8FQlx5ORX3oy8i%2Fadd%20payment%20method%20a1.png?alt=media&amp;token=3051b2c7-59cf-4b98-bcb7-697b2a08833e" alt=""><figcaption></figcaption></figure></div>

</details>

<details>

<summary>Viewing your subscription plan details</summary>

From the navigation menu, select `settings` ➥ `billing management` ➥ `subscription`. Here, you'll find current subscription, overage, and token balance information. For example:

<div align="left" data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FhNIJ73t4ggHNqexM9cKj%2Fsubscription%20page.png?alt=media&amp;token=2f0416c6-8935-4156-aaca-0ad4831ce127" alt=""><figcaption></figcaption></figure></div>

</details>

<details>

<summary>Purchasing a subscription plan</summary>

[Go to subscription plan details](#viewing-your-subscription-plan-details) for your account, then select the `manage plan` option from the current subscription plan panel. For example:

<div data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2Fw5we31Op3OKrYVyQPWDl%2Fmanage%20subscription%20plan%20a1.png?alt=media&amp;token=9b7a4e44-9fb3-4b4e-b3ec-8cff527eb8e9" alt=""><figcaption></figcaption></figure></div>

From here, you can view available plans and purchase a subscription.

{% hint style="info" %}
To purchase any subscription plan, you will be asked to select an existing payment method. You can add payment methods from [billing information](#adding-a-payment-method).
{% endhint %}

</details>

<details>

<summary>Cancelling your subscription plan</summary>

{% hint style="danger" %}
When a plan is cancelled, remaining tokens can be used until the next billing date. After this time, deployed pipelines will stop running, and cannot be initiated manually or via the Brigge API.
{% endhint %}

[Go to subscription plan details](#viewing-your-subscription-plan-details) for your account, then select the `cancel plan` option in the `current subscription plan` panel. For example:

<div data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2F9ZFJz66sParJtTChAvue%2Fcancel%20subscription%20a1.png?alt=media&amp;token=37eddaf4-3909-4ded-b6cb-232edbcc50b7" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
If you have added [overages](#how-does-overage-work) for your plan, remember to cancel this too. Overages are billed independently and, if used, will continue until cancelled.&#x20;
{% endhint %}

</details>

<details>

<summary>Viewing your subscription invoices</summary>

From the navigation menu, select `settings` ➥ `billing management` ➥ `invoices`:

<div data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2F7M8Vfmyvj2HDU7vBjQP2%2Fview%20invoices%20a1.png?alt=media&amp;token=84910f69-26f6-4515-9926-69f8fd841c42" alt=""><figcaption></figcaption></figure></div>

</details>

## Token usage

Tokens are consumed by the following actions:

<table><thead><tr><th width="230.853271484375">Action</th><th>Notes</th></tr></thead><tbody><tr><td>Pipeline runs</td><td>The more complex a pipeline or the larger its payloads (so processing takes longer), the more tokens are used.</td></tr><tr><td>AI usage</td><td>An AI operation (e.g. Ask Briggette; <a href="/documentation/brigge-for-transformers/pipelines/pipeline-nodes/map-node.md">generate mapping</a>; <a href="/documentation/brigge-for-transformers/pipelines/pipeline-nodes/custom-script-node.md">generate script</a>) consumes one token.</td></tr></tbody></table>

Token usage information is available in various places throughout Brigge, as summarised below.

<details>

<summary>Token usage detail view (subscription page)</summary>

To view your token balance, subscription plan, and overage settings, select `settings` ➥ `billing management` ➥ `subscription` from the navigation menu. Here, you'll find current subscription, overage, and token balance information. For example:

<div align="left"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FhNIJ73t4ggHNqexM9cKj%2Fsubscription%20page.png?alt=media&amp;token=2f0416c6-8935-4156-aaca-0ad4831ce127" alt=""><figcaption></figcaption></figure></div>

</details>

<details>

<summary>Token usage summary (dashboard)</summary>

You can see your token usage at a glance, from [your dashboard](#user-content-fn-1)[^1]. For example:

<div align="left" data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2Fmi0wmeN8V6XWNywtOmwB%2FToken%20usage%20-%20dashboard%20widget.svg?alt=media&amp;token=f2da6e90-ac03-4fb4-9297-ae5c3efc44c0" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
For more information, see [Dashboard](/documentation/brigge-for-operators/dashboard.md) documentation.
{% endhint %}

</details>

<details>

<summary>Token usage per pipeline run (history)</summary>

When viewing pipeline run history from [your history page](#user-content-fn-2)[^2], each run includes a token count. For example:

<div data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FDFxEFJMepEt1pXU9G0wI%2FToken%20usage%20-%20history.svg?alt=media&amp;token=e8657232-2fed-45db-a940-5df7860da880" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
For more information, see [History](/documentation/brigge-for-operators/history-and-retries.md) documentation.
{% endhint %}

</details>

<details>

<summary>Token usage per activity (activity logs)</summary>

You can filter [your activity logs](#user-content-fn-3)[^3] to view any activities that have consumed tokens. For example:

<div data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FPilLcbfrxJiKOiZaOBj7%2FToken%20usage%20-%20activity%20logs.svg?alt=media&amp;token=8355b811-0c74-42ea-a665-c550409b586e" alt=""><figcaption></figcaption></figure></div>

</details>

## How does overage work?

Activating *Overage* ensures that your pipelines keep running if your regular subscription allowance is exceeded. Additional tokens are used when required, on a pay-as-you-go basis.

{% hint style="info" %}
Overage use is calculated and billed on the [4th of each month](#key-dates-and-timings). The calculation is based on the number of tokens used above the allowance provided by your subscription plan. &#x20;
{% endhint %}

{% hint style="info" %}
In the event that your account drops into overage but your subscription plan is upgraded before the next billing date, overage is not charged. Instead, any tokens used that *would* have been charged as overage are deducted from your upgraded allowance.
{% endhint %}

When you activate *Overage*, you are prompted to [set a limit](#setting-an-overage-limit) for the number of overage tokens that can be used each month (so you stay in control of spend) OR you can [choose not to apply a limit](#setting-an-overage-limit).

<details>

<summary>Enabling overages for your account</summary>

[Access subscription plan details](#viewing-your-subscription-plan-details) for your account, then select the `activate overage` option:

<div data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2F1MJ7DkYMVJfxhwkmtgDi%2Factivate%20overage%201.png?alt=media&amp;token=8b235ba5-84b0-43f3-a411-72dd635646f7" alt=""><figcaption></figcaption></figure></div>

The *Change Subscription Plan* page is displayed, and you can purchase the *Overage* plan. Once you complete your purchase, the [set a limit](#setting-an-overage-limit) dialog is displayed, so you can decide how many overage tokens can be used each month.

{% hint style="info" %}
To purchase any subscription plan, you will be asked to select an existing payment method. You can add payment methods from [billing information](#adding-a-payment-method).
{% endhint %}

</details>

<details>

<summary>Setting an overage limit</summary>

To limit the number of overage tokens that can be used each month, or to allow an unlimited number, [access subscription plan details](#viewing-your-subscription-plan-details) for your account, move down to the `token usage` panel and select the `manage limit` option:

<div data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FGLZCSEvwzK8PEUXvuzdl%2Fmanage%20overage.png?alt=media&amp;token=8fc0edc6-ee94-4b99-944f-c5f5699d9045" alt=""><figcaption></figcaption></figure></div>

Here, you can specify the `token limit` allowed, or choose `unlimited`:

<div align="left" data-with-frame="true"><figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2F2B0g2U5gU2MLLfe96HNv%2FManage%20overage%20limit%202a.svg?alt=media&amp;token=79d6f0ba-c53c-437d-928b-f11be1f2dd2f" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
You must apply one of these settings for overage tokens to be used.&#x20;
{% endhint %}

</details>

<details>

<summary>Cancelling overage</summary>

{% hint style="danger" %}
Without overage tokens, pipelines will not run if your standard subscription plan allowance is exceeded. &#x20;
{% endhint %}

[Access subscription plan details](#viewing-your-subscription-plan-details) for your account, then select the `cancel plan` option in the `overage buffer` panel. For example:

<figure><img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2Fnll2XQu2OvfLXYdM8taC%2Foverage%20cancel%201.png?alt=media&amp;token=c75a61fe-939d-4894-bf6f-2bff61936612" alt=""><figcaption></figcaption></figure>

Having confirmed this action, overage tokens will stop immediately and your final invoice is issued on the next billing date. &#x20;

</details>

## What happens if I run out of tokens?

If your subscription allowance is reached and [overage](#how-does-overage-work) is *not* enabled for your account, pipelines will not run. This includes:

* Pipelines initiated on automated triggers
* Pipelines initiated manually
* Pipelines initiated via the Brigge API

## Key dates & timings

<table><thead><tr><th width="170.71875" valign="top">Type</th><th width="174.6458740234375" valign="top">When billed</th><th width="179.3203125" valign="top">New tokens available</th><th valign="top">Notes</th></tr></thead><tbody><tr><td valign="top">Initial monthly/annual subscription purchase</td><td valign="top">At the time of purchase</td><td valign="top"><p>Upon purchase completion</p><p></p><p></p></td><td valign="top">If you purchase part way through a month, the number of tokens is pro-rated to the end of that month</td></tr><tr><td valign="top">Monthly subscription billing</td><td valign="top">Last day of the month</td><td valign="top">First day of the month</td><td valign="top">New tokens replace any existing token balance; remaining tokens are not rolled over</td></tr><tr><td valign="top">Annual subscription billing</td><td valign="top">Last day of the last month of the year</td><td valign="top">First day of the month</td><td valign="top">New tokens replace any existing token balance; remaining tokens are not rolled over</td></tr><tr><td valign="top">Overage billing</td><td valign="top">4th of the month</td><td valign="top">N/A</td><td valign="top">Billing is for overage tokens used in the previous month (pay-as-you-go model)</td></tr></tbody></table>

[^1]: **How do I get there?**\
    Select *dashboard* from the main navigation menu:

    ![](https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FK9g4XlBig24G2Sd6u3PV%2Faccess%20dashboard%202.png?alt=media\&token=6ecf206b-27c8-482e-a6b1-989517e4291b)<br>

[^2]: **How do I get there?**\
    Select *History* from the main navigation menu:

    ![](https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2Fuh8A0QL1MOo8oKHbGF4u%2Faccess%20history.png?alt=media\&token=631b1a3a-8fe1-4614-b2d5-697b6adb1398)

[^3]: **How do I get there?**\
    Select *Settings* ➥ *Activity logs* from the main navigation menu:<br>

    <img src="https://2172380191-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8IqdqwZowcxtFpZfLa6k%2Fuploads%2FvzznBl3UIpITMx351CV0%2FToken%20usage%20-%20access%20activity%20logs.png?alt=media&amp;token=2210af33-c0e5-4bf7-8376-f361b50b06bf" alt="" data-size="original">
