Sign in

v1

latestOpenAPI 3.1.02026-07-2481742657.4 KB
Account Management

Get organization credit usage

Retrieve credit information for an organization over a specific date range. You must include a start date in your request.<br><br>Admins can obtain credit usage information for all users in their organization. Members may only retrieve usage information for their own account.<br><br>This endpoint does not cost any credits to execute.

get/v3/accounts/organizations/{organization_id}/credits/usage

Path parameters

organization_idstring uuid required

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

Example:11111111-2222-3333-4444-555555555555

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

Query parameters

datestring

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).

Example:2025-11-01

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).

start_datestring 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).

Example:2025-11-01

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).

end_datestring 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).

Example:2025-12-01

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).

granularity'daily' | 'monthly' required

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

Example:daily

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

include_consumer_breakdownboolean

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

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

Response

OK

Example response

{
  "result": {
    "credits_consumed_by_consumer": {
      "user@example.com": 3000
    },
    "granularity": "daily"
  }
}