---
title: "Get Free user credit usage"
method: GET
path: "/v3/accounts/users/credits/usage"
tags: ["Account Management"]
---

# Get Free user credit usage

`GET /v3/accounts/users/credits/usage`

Retrieve your Free user account credit consumption information over a specific date range. You must include a start date in your request.<br><br>This endpoint does not cost any credits to execute.

## Query parameters

- `date` string — 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_date` string, 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).
- `end_date` string, 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).
- `granularity` 'daily' | 'monthly', required — Whether to break down credit usage on a daily or monthly basis.

## Response `200`

OK

- ResponseEnvelopeCreditUsageReport
  - `result` CreditUsageReport
    - `credits_consumed_by_consumer` object — The breakdown of credits consumed by consumer. This may not be present if the report is generated for a specific user.
    - `credits_consumed_by_source` SourceUsageBreakdown, required
      - `api` integer, required — The amount of credits consumed through the Platform API.
      - `auto_replenishment` integer — The amount of credits consumed through auto-replenishment.
      - `other` integer — The amount of credits consumed through other operations.
      - `ui` integer, required — The amount of credits consumed through the Platform UI.
    - `end_time` string, date-time, required — The end time of the window for this report.
    - `granularity` 'daily' | 'monthly', required — The granularity of the report.
    - `periods` CreditUsageReportPeriod[], nullable, required — The periods of the report (i.e. time buckets).
      - `credits_added` integer, required — The total amount of credits added during the report period.
      - `credits_consumed` integer, required — The total amount of credits consumed during the report period.
      - `credits_expired` integer, required — The total amount of credits expired during the report period.
      - `end_date` string, date-time, required — The end date of the window for this report period.
      - `start_date` string, date-time, required — The start date of the window for this report period.
      - `transaction_count` integer, required — The total number of transactions during the report period.
    - `start_time` string, date-time, required — The start time of the window for this report.
    - `total_added` integer, required — The total amount of credits added during the report period.
    - `total_consumed` integer, required — The total amount of credits consumed during the report period.
    - `total_expired` integer, required — The total amount of credits expired during the report period.
    - `transaction_count` integer, required — The total number of transactions during the report period.

## Other responses

- `400` — Bad request
- `401` — Request does not contain a valid Authorization token
- `404` — User not found
- `500` — Internal server error

---

[API](https://skmtc.net/censys/apis/censys-platform-api.md) · [All operations](https://skmtc.net/censys/apis/censys-platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/censys/censys-platform-api/revisions/261c916bf05b/schema)