Articles on: Account & Subscription

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 total merged data is lower or equal to 1MB, the merge data is: the JSON dataset size, size of image injected and the size of concatenated PDFs.
If you consume extra documents, they will be charged and reset at the end of the billing period.

To compute the number of Document consumed:
(Size of JSON dataset as Bytes + Downloaded Images Bytes + Downloaded Concatenated PDF Bytes) / 1 000 000 = Document Consumed

Accounts created before the 17th of May 2024 have free image downloads. The Document calculation is: (Size of JSON Dataset as Bytes + Downloaded Concatenated PDF Bytes) / 1 000 000 = Document Consumed

Document Usage Example

A JSON data-set of :
- 0.5MB Json = 1 document
- 1.2MB Json = 2 documents
- 1KB Json + 1MB images + 0.3MB Concat PDF = 3 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: 05/17/2024

Was this article helpful?

Share your feedback


Thank you!