---
title: "Get usage"
method: GET
path: "/usage"
tags: ["usage"]
---

# Get usage

`GET /usage`

## Request

- Base URL: `https://storeinspect.com/api/v1`
- URL: `https://storeinspect.com/api/v1/usage`
- Auth: HTTP bearer

Returns API access state, request quota, search-row quota, and shared contact-credit usage for the authenticated account.

## Response `200`

Usage for the authenticated account.

- UsageResponse
  - `object` 'usage', required
  - `plan` object, required
    - `slug` 'free' | 'pro' | 'business' | 'enterprise', required
    - `name` string, required
    - `status` string, required
    - `trial` object, required
      - `active` boolean, required
      - `ends_at` string, date-time, nullable, required
  - `contact_credits` object, required
    - `total` integer, required
    - `used` integer, required
    - `remaining` integer, required
    - `paid_plan_total` integer, required
    - `period_start` string, date-time, required
    - `period_end` string, date-time, required
  - `store_exports` object, required
    - `limit` integer, required
    - `used` integer, required
    - `reserved` integer, required
    - `remaining` integer, required
    - `period_start` string, date-time, required
    - `period_end` string, date-time, required
  - `api_requests` object, required
    - `limit` integer, required
    - `used` integer, required
    - `remaining` integer, required
    - `period_start` string, date-time, required
    - `period_end` string, date-time, required
  - `search_rows` object, required
    - `limit` integer, required
    - `used` integer, required
    - `remaining` integer, required
    - `period_start` string, date-time, required
    - `period_end` string, date-time, required
  - `rate_limit` object, required
    - `limit` integer, required
    - `interval` string, required
  - `billing` TrialCreditBillingAction
    - `can_unlock_paid_credits_now` boolean
    - `action` 'end_trial_to_unlock_pro_credits', required
    - `current_limit` integer, required
    - `paid_plan_limit` integer, required
    - `trial_ends_at` string, date-time, nullable, required
    - `url` string, uri, required
  - `key` object, required
    - `id` string, required
    - `name` string, required
    - `mode` 'live' | 'test', required
  - `request_id` string, required

## Other responses

- `401`: Missing or invalid API key.
- `403`: The account does not have API access.

---

[API](https://skmtc.dev/storeinspect/apis/storeinspect-api.md) · [All operations](https://skmtc.dev/storeinspect/apis/storeinspect-api/llms.txt) · [OpenAPI document](https://skmtc.dev/storeinspect/apis/storeinspect-api/revisions/e9477dd90cf9?raw)