> For the complete documentation index, see [llms.txt](https://docs.licensespring.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.licensespring.com/consumption-pools/creating-and-managing-pools.md).

# Creating and Managing Pools

Pools belong to a customer account. To manage them, open a customer account and select the **Consumption pools** tab.

Show Image

The tab displays:

* **Summary cards:** The total number of pools on the account, and how many are currently in overage or depleted.
* **Pools list: E**ach pool's name, code, type, a live usage meter, status, reset schedule, and date of last reset.
* **Usage report:** A per-pool consumption chart scoped to this account. See Usage Reports and Activity.

Managing pools requires the `licenses_write` permission. Viewing requires `licenses_read`.

### Creating a Pool

<figure><img src="https://1783554078-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgLzurdfXUuKr9IziZWLz%2Fuploads%2Fvl8LBAZbhWIyVKRjGpu0%2FScreenshot%202026-09-29%20at%203.37.46%E2%80%AFPM.png?alt=media&amp;token=b406cc2a-5258-4c65-9f7a-e0e4231024e9" alt=""><figcaption></figcaption></figure>

Click **New pool**. The following fields are available:

<table data-search="false"><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><strong>Name</strong></td><td>Display name, can be edited after creation</td></tr><tr><td><strong>Code</strong></td><td>Unique identifier within the customer account. Cannot be changed after creation.</td></tr><tr><td><strong>Type</strong></td><td><strong>Licenses</strong> or <strong>Product features</strong>. Cannot be changed after creation.</td></tr><tr><td><strong>Max consumptions</strong></td><td>The shared quota for this pool</td></tr><tr><td><strong>Allow unlimited consumptions</strong></td><td>Removes the cap entirely</td></tr><tr><td><strong>Allow overages / Max overages</strong></td><td>Additional consumption allowed past the maximum. Set <strong>Max overages</strong> to <code>0</code> for unlimited overages when overages are enabled.</td></tr><tr><td><strong>Allow negative consumptions</strong></td><td>Enabled by default. The pool balance floors at zero.</td></tr><tr><td><strong>Reset consumption / Consumption period</strong></td><td>Schedules automatic resets of the pool balance</td></tr><tr><td><strong>Default offline checkout</strong></td><td>The number of units reserved when a device activates offline without specifying an amount. See Offline Checkouts.</td></tr></tbody></table>

<figure><img src="https://1783554078-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgLzurdfXUuKr9IziZWLz%2Fuploads%2FUBqJInRjq2sKYBruVswf%2FScreenshot%202026-09-29%20at%203.38.23%E2%80%AFPM.png?alt=media&amp;token=02e005a2-6279-4e07-acfc-a2884a4e7a9b" alt=""><figcaption></figcaption></figure>

### The Pool Detail Page

The **balance card** at the top shows the live state of the pool:

* The meter divides the used portion into **Consumed** (settled usage) and **Held by offline checkouts** (a striped segment representing units reserved by offline devices, which return to the pool when those devices sync).
* **Available to spend now** = quota − consumed − held.
* When overages are enabled, a divider marks the maximum consumption line and the overage zone is shaded distinctly.

When a pool is depleted, a banner appears explaining that member consumption requests are being rejected with `pool_quota_exhausted`.

<figure><img src="https://1783554078-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgLzurdfXUuKr9IziZWLz%2Fuploads%2F78Ebn5US3VcgSBnn6sFp%2FScreenshot%202026-09-29%20at%203.47.00%E2%80%AFPM.png?alt=media&amp;token=5becaef8-4c9c-4f41-bb4a-35d4c057c53c" alt=""><figcaption></figcaption></figure>

### Editing a Pool

Click **Edit pool** to update the name, quota, overage settings, negative consumption flag, or reset schedule. The **Code** and **Type** fields are locked after creation, they appear disabled in the edit form and cannot be changed via the API either.

<figure><img src="https://1783554078-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgLzurdfXUuKr9IziZWLz%2Fuploads%2FO1BDknMdpqbvkDswcwND%2FScreenshot%202026-09-29%20at%203.47.25%E2%80%AFPM.png?alt=media&amp;token=32096bfd-082c-446d-af9b-d25811cbebec" alt=""><figcaption></figcaption></figure>

### Resetting a Pool

**Reset pool** zeroes the pool's balance and every linked member's contribution counter in a single atomic operation. This keeps per-member reporting consistent with the pool total. Activity records are written for the pool and for each affected member.<br>

<figure><img src="https://1783554078-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgLzurdfXUuKr9IziZWLz%2Fuploads%2FDV2OsO3Cp6wQjAmFjPYK%2FScreenshot%202026-09-29%20at%203.47.58%E2%80%AFPM.png?alt=media&amp;token=818af62f-0e33-44a7-916f-9b84f291ff14" alt=""><figcaption></figcaption></figure>

Pools can also reset automatically on a schedule, configured through the **Reset consumption** and **Consumption period** fields.

{% hint style="info" %}
While a license or feature is linked to a pool, it is excluded from its own scheduled resets , the pool's reset schedule is the only one that applies. Manual resets of individual members are still supported. See Pool Members.
{% endhint %}

### Deleting a Pool

Deleting a pool unlinks all its members without modifying their individual counters. Each member returns to standalone metering, retains its own `total_consumptions`, and its own configuration takes effect immediately. Only the shared quota is removed.

Before confirming, a dialog shows how many members will be affected.

<figure><img src="https://1783554078-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgLzurdfXUuKr9IziZWLz%2Fuploads%2FB0SnUzWKSmTOqwpd03QM%2FScreenshot%202026-09-29%20at%203.49.22%E2%80%AFPM.png?alt=media&amp;token=753179e3-8f11-4afc-bf87-fe03df78746d" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.licensespring.com/consumption-pools/creating-and-managing-pools.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
