> ## Documentation Index
> Fetch the complete documentation index at: https://storeinspect.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get usage

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



## OpenAPI

````yaml /openapi.json get /usage
openapi: 3.1.0
info:
  title: StoreInspect API
  version: 1.0.0
  description: >-
    Database-backed Shopify store and contact intelligence API. Store and
    contact data require a paid StoreInspect plan; existing keys can still
    access billing recovery endpoints after paid access lapses.
servers:
  - url: https://storeinspect.com/api/v1
security: []
tags:
  - name: usage
    x-displayName: Usage
    x-group: Usage
    description: >-
      API access state, request quotas, search-row quota, and shared
      contact-credit usage.
  - name: billing
    x-displayName: Billing
    x-group: Billing
    description: >-
      Read subscription state and create short-lived Stripe-hosted subscription
      or management links.
  - name: taxonomy
    x-displayName: Taxonomy
    x-group: Taxonomy
    description: >-
      Filter values, labels, and metadata used by store and contact search
      requests.
  - name: stores
    x-displayName: Stores
    x-group: Stores
    description: >-
      Store lookup, store search, and batch domain enrichment for Shopify
      accounts.
  - name: contacts
    x-displayName: Contacts
    x-group: Contacts
    description: Contact preview search and credit-based contact reveal workflows.
paths:
  /usage:
    get:
      tags:
        - usage
      summary: Get usage
      description: >-
        Returns API access state, request quota, search-row quota, and shared
        contact-credit usage for the authenticated account.
      operationId: getUsage
      responses:
        '200':
          description: Usage for the authenticated account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageResponse'
        '401':
          description: Missing or invalid API key.
        '403':
          description: The account does not have API access.
      security:
        - bearerAuth: []
components:
  schemas:
    UsageResponse:
      type: object
      properties:
        object:
          type: string
          const: usage
        plan:
          type: object
          properties:
            slug:
              type: string
              enum:
                - free
                - pro
                - business
                - enterprise
            name:
              type: string
            status:
              type: string
            trial:
              type: object
              properties:
                active:
                  type: boolean
                ends_at:
                  type:
                    - string
                    - 'null'
                  format: date-time
              required:
                - active
                - ends_at
          required:
            - slug
            - name
            - status
            - trial
        contact_credits:
          type: object
          properties:
            total:
              type: integer
              minimum: 0
            used:
              type: integer
              minimum: 0
            remaining:
              type: integer
              minimum: 0
            paid_plan_total:
              type: integer
              minimum: 0
            period_start:
              type: string
              format: date-time
            period_end:
              type: string
              format: date-time
          required:
            - total
            - used
            - remaining
            - paid_plan_total
            - period_start
            - period_end
        api_requests:
          type: object
          properties:
            limit:
              type: integer
              minimum: 0
            used:
              type: integer
              minimum: 0
            remaining:
              type: integer
              minimum: 0
            period_start:
              type: string
              format: date-time
            period_end:
              type: string
              format: date-time
          required:
            - limit
            - used
            - remaining
            - period_start
            - period_end
        search_rows:
          type: object
          properties:
            limit:
              type: integer
              minimum: 0
            used:
              type: integer
              minimum: 0
            remaining:
              type: integer
              minimum: 0
            period_start:
              type: string
              format: date-time
            period_end:
              type: string
              format: date-time
          required:
            - limit
            - used
            - remaining
            - period_start
            - period_end
        rate_limit:
          type: object
          properties:
            limit:
              type: integer
              minimum: 0
            interval:
              type: string
          required:
            - limit
            - interval
        billing:
          $ref: '#/components/schemas/TrialCreditBillingAction'
        key:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            mode:
              type: string
              enum:
                - live
                - test
          required:
            - id
            - name
            - mode
        request_id:
          type: string
      required:
        - object
        - plan
        - contact_credits
        - api_requests
        - search_rows
        - rate_limit
        - key
        - request_id
    TrialCreditBillingAction:
      type: object
      properties:
        can_unlock_paid_credits_now:
          type: boolean
        action:
          type: string
          enum:
            - end_trial_to_unlock_pro_credits
        current_limit:
          type: integer
          minimum: 0
        paid_plan_limit:
          type: integer
          minimum: 0
        trial_ends_at:
          type:
            - string
            - 'null'
          format: date-time
        url:
          type: string
          format: uri
      required:
        - action
        - current_limit
        - paid_plan_limit
        - trial_ends_at
        - url
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: StoreInspect API key

````