API Reference

Get organization credit usage

get
https://api.platform.censys.io/v3/accounts/organizations//credits/usage

Retrieve credit information for an organization over a specific date range. You must include a start date in your request.

Admins can obtain credit usage information for all users in their organization. Members may only retrieve usage information for their own account.

This endpoint does not cost any credits to execute.

Path Params
uuid
required

The ID of a Censys organization. See the Getting Started docs for more information.

Query Params
string
deprecated

The date for the credit usage report in YYYY-MM-DD format (e.g., 2025-11-06). This field is deprecated and will be removed in a future version. Use start_date and end_date instead. The date must be on or after 2025-01-01 (the earliest date available for credit usage reports).

date

The start date for the credit usage report in YYYY-MM-DD format (e.g., 2025-11-01). Must be on or after 2025-01-01 (the earliest date available for credit usage reports).

date

The end date for the credit usage report in YYYY-MM-DD format (e.g., 2025-12-01). If omitted, will default to today's date. The date range (end_date - start_date) cannot exceed 365 days (1 year).

string
enum
required
Defaults to daily

Whether to break down credit usage on a daily or monthly basis.

Allowed:
boolean
Defaults to false

Whether to include a breakdown of individual users' consumption in the credit usage report.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 3 months ago

Language
Credentials
Bearer
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json
Updated 3 months ago