Document quota and usage on the Carbone Cloud API

What is a Document?

A Document, previously known as "Credit" or "Render", is a unit for generating reports through the Carbone Cloud API.
A plan gives you access to a quota of Documents to consume during a billing period (monthly/yearly).

One document is consumed when:
the endpoint POST /render/:templateID is requested to generate a report with the production API key
and the JSON dataset size is lower or equal to 800KB
and image size to download are lower or equal to 800KB (only when dynamic pictures are included in your reports).
If you consume extra documents, they will be charged and reset at the end of the billing period.

Document Usage Example

A JSON data-set of :
- 500KB = 1 document
- 1000KB = 2 documents
- 1000KB + images size of 3000KB = 5 documents

You can find your document usage on the home page of your account:
Subscription panel: Usage during the billing period of your subscription
Analytics panel: Usage during an hourly/daily/monthly period

Usage limit

The Carbone Cloud API allows uninterrupted usage, even when reaching document quotas in production environments. Users can receive email notifications at 70%, 90%, and 100% usage by enabling the "Carbone Cloud API document usage" setting in their profile. Click to learn more.

Updated on: 01/26/2024