Skip to main content
GET
Monthly usage totals

Authorizations

Authorization
string
header
required

One of your API keys (zpl_live_… or zpl_test_…), created at https://caretly.dev/console/keys. Revoked keys are refused immediately.

Query Parameters

month
string

The calendar month in UTC, as YYYY-MM. Defaults to the current month.

Pattern: ^[0-9]{4}-[0-9]{2}$
Example:

"2026-10"

Response

Totals for the month.

month
string
required
Example:

"2026-10"

live_labels
integer
required

Live labels, including free_labels.

Example:

6170

free_labels
integer
required

Live labels rendered with free access: never billed, also after it ended.

Example:

0

test_labels
integer
required

Free, watermarked labels.

Example:

500

requests
integer
required

Render requests, live and test.

Example:

2253

estimated_cost
object
required