Skip to content

Plans and Services

Overview

In the myBiros Platform, a Plan defines how much processing capacity, measured in processed pages, is available to one or more of your services. There are two types of plans: Trial Plans, which offers a fixed quota for evaluation purposes, and Premium Plans, which define a usage quota available on a monthly or annual basis.

Note

The terms "Use Case" and "Service" refer to the same concept and are used interchangeably.

How Plans and Services Work Together

  • Each service always belongs to exactly one plan.
  • A single plan can include multiple services.
  • A plan's available usage quota is shared among all services attached to it.

Tip

You can view your current plans, their usage status and the services attached to them in the Plan section of the myBiros Platform.

Frequently Asked Questions (FAQ)

What happens when a plan’s usage limit is reached?

Once the plan’s usage limit is reached, all services linked to the plan will stop processing new documents. You’ll need to upgrade your plan to start processing again. Some plans may offer a tolerance threshold beyond the stated quota, which may be tracked and billed separately based on your organization’s configuration.

Do unused quotas carry over to the next period?

No. Usage quotas are non-cumulative, any unused quotas is reset at the end of the current usage period.

How is usage allocated for services attached to the same plan?

All services linked to the same plan consume the plan’s total quota. Usage is aggregated across services, not tracked separately. For example, let’s say you have a plan with an available quota of 100 pages, and you have two services attached to this plan:

  • Identity Documents, which you use to process 60 pages
  • Utility Bills, which you use to process another 30 pages

In this case, the total usage on the plan is 90 pages (60 processed using the Identity Documents service and 30 using the Utility Bills service), leaving 10 pages available in the plan’s quota.

How can I view the usage of a plan via API?

You can view the usage of a plan via the API by using the dedicated endpoint, which allows you to retrieve the current usage and usage limit of the plan to which a service is attached. Additionally, the same information is provided in the response headers of the Inference and Async Inference endpoints, allowing you to monitor usage in real-time as documents are processed.