Get managed-account usage
Read managed accounts, active Agents and print jobs for one UTC calendar month.
What this endpoint does
Read managed accounts, active Agents and print jobs for one UTC calendar month.
Authentication
Send a one-time RS256 Developer Application assertion in Authorization: Bearer <application_assertion>. This assertion is not a Public API access token.
Request
Production base URL: https://public-api.cloudprint.me/partner-api/v1/usage
Parameters
| Name | Location | Type | Required | Description | Constraints |
|---|---|---|---|---|---|
period | query | string | no | UTC calendar month in YYYY-MM format used for the usage report. | example: "2026-08" |
X-Request-Id | header | string | no | Optional request identifier for tracing; CloudPrint returns a safe value in the response header. | maxLength: 128; example: "order-100045-attempt-1" |
Request body
This endpoint has no request body.
Example requests
cURL
bash
curl -sS 'https://public-api.cloudprint.me/partner-api/v1/usage?period=2026-08' \
-H "Authorization: Bearer $APPLICATION_ASSERTION"Response
HTTP status: 200 — Partner usage
Response fields
| Name | Type | Required | Description | Constraints |
|---|---|---|---|---|
period | string | yes | UTC calendar month in YYYY-MM format used for the usage report. | — |
starts_at | string (date-time) | yes | ISO 8601 timestamp recorded by CloudPrint. | — |
ends_at | string (date-time) | yes | ISO 8601 timestamp recorded by CloudPrint. | — |
managed_accounts | integer | yes | Number of managed customer accounts included in the usage period. | min: 0 |
active_agents | integer | yes | Number of active agents counted for the requested UTC calendar month. | min: 0 |
print_jobs | integer | yes | Print jobs returned for the current account and filters. | min: 0 |
Example response
json
{
"period": "2026-08",
"starts_at": "2026-08-06T12:00:00Z",
"ends_at": "2026-08-06T12:00:00Z",
"managed_accounts": 0,
"active_agents": 0,
"print_jobs": 0
}Errors
| HTTP status | Description |
|---|---|
401 | Application assertion is invalid |
403 | Developer Account production access is not active |
422 | Period is invalid |
429 | Rate limit exceeded |
500 | Unexpected error |
Related documentation
Create and manage customer accountsAuthenticate Partner API requests, create managed customer accounts, and suspend, resume or close them when needed.List managed customer accountsList customer accounts provisioned by the authenticated Developer Application, including Agent and printer health.CloudPrint API errors and retriesHandle CloudPrint API status codes, machine-readable errors, rate limits, request tracing and safe retry decisions.