Everything about Credits

Summary: One generated document usually corresponds to one consumed credit. If your JSON dataset is larger than 800KB, it will consume more credits.

What is a credit?

A credit, previously known as "render", is a unit for generating reports through the Carbone Cloud API.
A plan gives you access to a quota of credits to consume during a billing period (monthly/yearly).
One credit 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 credits, they will be charged and reset at the end of the billing period.

Credit Usage Example

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

You can find your credit 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

Updated on: 11/30/2023