> For the complete documentation index, see [llms.txt](https://docs.digibee.com/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digibee.com/documentation/licensing/licensing-models/consumption-based-model.md).

# Consumption-Based Model

Learn how the Consumption-Based Model works on the Digibee Integration Platform.

{% hint style="info" %}
This documentation is **exclusive** to customers using the Consumption-Based Model and may not be applicable to your realm.
{% endhint %}

The Consumption-Based Model is a licensing model of the Digibee Integration Platform in which pricing is based on the consumption of metrics related to pipeline executions, GB-seconds, and egress traffic.

## How does it work?

You purchase credits based on your needs, and each metric consumes a different amount of credits during the contracted period. You can track your credit usage within the Platform to effectively monitor and manage consumption.

{% hint style="success" %}
Consumption is valid for all environments.
{% endhint %}

## Understanding the Consumption metrics

* **GB-seconds (gigabytes.seconds or GB-s):** Represents the lifespan of a pipeline instance (replicas) multiplied by its memory size in GB. For example:
  * **Small:** 0,0625 GB | 64 MB | 10 threads | 20% CPU
  * **Medium:** 0,125 GB | 128 MB | 20 threads | 40% CPU
  * **Large**: 0,25 GB | 256 MB | 40 threads | 80% CPU

**Number of pipeline executions:** Represents the total number of executions of a pipeline.

**Number of Egress Traffic bytes:** Represents all data traffic that leaves the Digibee Integration Platform, whether to the public internet, to another cloud, or to a local network.

## Calculation used in the Consumption-Based Model

Refer to the example below to understand how billing calculations work in the Consumption-Based Model. 

{% hint style="warning" %}
The financial values used in the following example are **illustrative only**. They are meant to show how consumption-based pricing is calculated, and **do not reflect the actual rates charged on the platform**. Your specific rates are defined in your contract.
{% endhint %}

**Example:** 1,000 executions in 1 small pipeline replica running for 1 hour, consuming 1GB of egress traffic.

**GB-s:** 0.0625 GB \* 3600s = 225 GB-s \* 0.0008 = $ 0.18

**Executions:** 1,000 \* 0.000008 = $0.008

**Egress Traffic**: 1GB \* 0.50 = $0.50

**Total =** GB-s + Executions + Egress Traffic = $ 0.688

## Consumption-Based Model on the Platform

### How to access your data

1. Click the **Digibee logo** in the upper-left corner of the platform home page.
2. Select **Settings**.
3. In the left menu, find the **Licensing** section and click **Runtime Compute**.

The Consumption page on the Digibee Platform is divided into two tabs: **Contract Overview** and **Detailed Usage & Costs**. Below, you’ll learn how to interpret the data and make better use of the available resources.

{% hint style="warning" %}
The screenshots below show a sample environment. The values displayed are illustrative only and **do not reflect actual charges on the platform**.
{% endhint %}

### Contract Overview

Displays information based on consumption cycles.

#### Contract

This tab displays information about the contract established with Digibee, including:

* **Contract term:** Duration of the contract, including the effective and expiration dates.
* **Granted:** Total amount of active credits purchased by the customer available until next unlock.
* **Total commitment:** Total amount of credits under the contract.
* **Next unlock:** Scheduled date when more credits become available under the contract..

<figure><img src="https://1094491232-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOhzhFKeTGI53IPSy3U9T%2Fuploads%2Fnf9x3z6odP1BclihkJZB%2FContract_ENG.png?alt=media&amp;token=c85a2687-ede0-4f9a-9210-3e3d8af051f2" alt=""><figcaption></figcaption></figure>

#### Consumption

* **Consumed vs. Prepaid Commit:** Amount of purchased credits vs. consumed credits. Consumption is cumulative and also shown as a percentage of usage.
* **Incentives utilization:** Credits granted by Digibee and their expiration date. Displayed only if the customer has active incentive credit.

<div><figure><img src="https://1094491232-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOhzhFKeTGI53IPSy3U9T%2Fuploads%2FA80OIFRob40D79ybnBo8%2FConsumed_prepaid_eng.png?alt=media&amp;token=529ffca5-e565-420f-8128-1f6e3ae21a83" alt=""><figcaption></figcaption></figure> <figure><img src="https://1094491232-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOhzhFKeTGI53IPSy3U9T%2Fuploads%2FncWTYZQUGEbFuRYCFK6V%2FIncentives_ENG.png?alt=media&amp;token=de0e3b47-4b44-49c8-a5ba-9ea226ccc5b8" alt=""><figcaption></figcaption></figure></div>

#### Charts and tables

* **Credits usage chart:** Displays the evolution of credit consumption over time, including total contracted credits, cumulative net consumption, and monthly consumption. The current month is displayed up to the previous day.
* **Credits history table:** Displays the credit type, status (active, expired, or future), granted amount, and spent amount.
  * The `EXPIRED` status appears both when credits exceed the contracted period and when they are fully consumed within it.
* **Invoice history table:** Displays the month and the remaining balance to be paid after deducting active credits from the total consumption, calculated at the standard unit price, if applicable. When there's usage beyond the contracted limit, the current month appears at the top with an **Open** badge, as open invoices may change until the month closes.
* **Pricing table:** Displays unit pricing for Consumption-Based metrics such as Executions, GBs, and Egress.

<figure><img src="https://1094491232-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOhzhFKeTGI53IPSy3U9T%2Fuploads%2FSMTlBwMuFr8zCMISRsg1%2Ftotalcredits_chatt.png?alt=media&amp;token=d568939c-964c-427f-9ef9-d8e4f8a4068f" alt=""><figcaption></figcaption></figure>

### Detailed Usage & Costs

#### Analysis Period

Select the date range and environment to analyze your usage. The tab shows a 30-day period by default. However, you can analyze a predefined range or a specific date of your choice.

Costs are detailed according to the consumption metrics:

* **Total cost:** Total amount of credits spent in the selected period.
* **Total cost of GB-s:** Total cost and total amount of GB-s used in the selected period.
* **Total cost of Executions:** Total cost and total number of executions based on the total volume of pipeline activations in the selected period.

Besides the usage information, you can:

* Use the **Digibee Docs button** to check more detailed information about the Consumption-Based Model in our Documentation Portal.&#x20;
* Use the **Download CSV button** to export your consumption reports in CSV format directly from the Platform. The exported data reflects the time period selected in the active filter, and no other filters can be applied.

<figure><img src="https://1094491232-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOhzhFKeTGI53IPSy3U9T%2Fuploads%2Fh6eBSTpq5jYKYTWxQ2Zn%2FAnlysis_Period_eng.png?alt=media&amp;token=de1ab224-713d-4ac1-9afa-6254933105ef" alt=""><figcaption></figcaption></figure>

#### Breakdown table

After selecting the time period, you can analyze your consumption data by **projects** or by **pipelines** using the **search bar.**

The table displays data by the following categories:&#x20;

* **Name**
* **Usage in GB-s and its corresponding value**
* **Executions and their corresponding value**
* **Total cost.**

<figure><img src="https://1094491232-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOhzhFKeTGI53IPSy3U9T%2Fuploads%2FNOjZoHhzXkab4wAyc8CS%2FBreadkdown_eng.png?alt=media&amp;token=7dd8bfce-6e1b-4dc6-a15a-a938d837a592" alt=""><figcaption></figcaption></figure>

### **Consumption alerts**

The **Consumption alerts** tab lets you create, edit, and view alerts that notify you when the consumption of a contract, project, or pipeline approaches a defined limit. Configuring alerts makes it easier to plan and manage your integration resources ahead of time.

#### **Creating an alert**

1. In the **Consumption alerts** tab, click **Create alert**.
2. Fill in the following fields:

| Field                     | Description                                                                                                                                                                                             |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Alert name**            | The name of the alert. This field is required and accepts up to 100 characters.                                                                                                                         |
| **Scope**                 | Defines the alert level: **Contract**, **Project**, or **Pipeline**. Contract uses the current contract. If you select Project or Pipeline, choose the corresponding project or pipeline.               |
| **Threshold Type**        | Available for the **Contract** scope only. Choose **Percentage (%)** or **Absolute Value** for the threshold. Project and Pipeline scopes support only Absolute Value.                                  |
| **Threshold Value**       | For percentage thresholds, move the slider or type a value between 1 and 100. The default is 70%. For absolute value thresholds, enter the amount in the contract currency, for example `500`.          |
| **Notification Channels** | Choose one or more channels: Email (enter the email address), Slack (enter the incoming webhook URL), or Webhook (enter the endpoint URL). You can optionally enter an HMAC secret to sign the payload. |

3. Click **Create alert** to confirm.

{% hint style="info" %}
At least one notification channel is required to create an alert.
{% endhint %}

#### **Viewing alerts**

Created alerts are displayed in a table in the **Consumption alerts** tab. The table shows the following information:

| Column             | Description                                                                                                                                                                                                                                                                                                |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Name**           | The name defined when the alert was created.                                                                                                                                                                                                                                                               |
| **Scope**          | The alert scope: Contract, Project, or Pipeline.                                                                                                                                                                                                                                                           |
| **Channels**       | The configured notification channels.                                                                                                                                                                                                                                                                      |
| **Status**         | **Active**: the alert is on and monitoring. **Triggered**: a percentage alert fired; it keeps monitoring and returns to Active if consumption drops or the percentage is raised above it. **Disabled**: the alert is off, either manually or because an absolute-value alert fired and stopped monitoring. |
| **Last triggered** | The date the alert was last triggered. Displays `Never` if the alert has not been triggered yet.                                                                                                                                                                                                           |
| **Actions**        | Available options: enable or disable, edit, or delete the alert.                                                                                                                                                                                                                                           |


---

# 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.digibee.com/documentation/licensing/licensing-models/consumption-based-model.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.