---
title: "Get Usage"
method: GET
path: "/v1/usage"
---

# Get Usage

`GET /v1/usage`

Get credit balance, purchase history, usage history, and Auto Reload settings for the authenticated user.

## Response `200`

Successful Response

- GetUsageResponseV1 — Response from GET /v1/usage - retrieving user's credit purchases and usage history.
  - `balance_credits` integer, required — Current credit balance (can be negative if credits consumed without sufficient balance)
  - `has_credits` boolean, required — Whether the user has credits available (balance > 0)
  - `purchases` ApiPurchaseV1[], required — List of credit purchases, most recent first
    - `id` string, required — Unique identifier for the purchase
    - `credits` integer, required — Number of credits purchased
    - `purchased_at` string, required — When the purchase was made (ISO 8601 format)
  - `usage` ApiUsageV1[], required — List of credit usage records, most recent first
    - `id` string, required — Unique identifier for the usage
    - `credit_used` integer, required — Number of credits consumed
    - `created_at` string, required — When the usage was recorded (ISO 8601 format)
    - `resource_id` string, nullable — ID of the resource that consumed the credits (search ID or research ID)
    - `resource_type` string, nullable — Type of resource: 'search' or 'research'
  - `auto_reload` AutoReloadSettingsV1 — Auto Reload configuration
    - `enabled` boolean, required — Whether Auto Reload is enabled
    - `threshold_credits` integer, required — Credits threshold that triggers Auto Reload
    - `reload_credit_amount` integer, required — Number of credits to purchase on Auto Reload
    - `last_reload_at` string, nullable — Last Auto Reload timestamp (ISO 8601 format)
  - `top_up_url` string — URL to purchase more credits

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `402` — Payment Required
- `403` — Forbidden
- `404` — Not Found
- `410` — Gone
- `422` — Validation Error
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/happenstance/apis/happenstance-api.md) · [All operations](https://skmtc.net/happenstance/apis/happenstance-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/happenstance/happenstance-api/versions/d5e1f45dc5e4/schema)