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

# Get account usage

> Retrieve credit usage statistics and operation breakdown for an account.

## Use Case:

Review credit usage by operation type for the selected billing period.


## OpenAPI

````yaml get /api/v1/accounts/usage/
openapi: 3.0.3
info:
  title: Generect API
  description: >-
    Welcome to the Generect API documentation. Here we will help you integrate
    and use our API.


    API base url: `https://api.generect.com` — every path below is relative to
    this host. Newer endpoints live under `/api/v1/...`, legacy endpoints under
    `/api/...`; use each path exactly as documented.

    Protocol: `HTTPS`


    # Authentication


    Get your API token from the Generect app settings and send it in the
    `Authorization` header with the required `Token` prefix.


    Example: `Authorization: Token xxxxxxxxx`


    # Rate limits


    You can request data depending on your data plan and account balance
    (default: 10000/month). Pricing depends on the operation and the number of
    results returned, and may increase with additional data flags. For exact
    pricing, see each endpoint's Pricing section or your billing settings:
    https://beta.generect.com/settings/billing


    # Note


    _Every endpoint must include the trailing `/`. Requests without the trailing
    slash may fail._
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.generect.com
security:
  - apiKey: []
tags:
  - name: 1. Auth
    description: Login and get user info
  - name: 2. Transactions
    description: List of latest transactions in your account
  - name: 3. Leads
    description: Fetch information about leads by _link/name/ICP_.
  - name: 4. Companies
    description: Fetch information about companies by link/name/ICP.
  - name: 5. Preview
    description: Search masked database leads for preview and reveal workflows.
  - name: 6. Enrich
    description: Enrich leads and companies by internal or external identifiers.
  - name: 7. Email
    description: Find and validate email addresses.
  - name: 8. Accounts
    description: Account profile, usage, and transactions.
  - name: 9. Search
    description: Database and realtime lead, company, and company-lead search.
  - name: 10. Phone
    description: Find phone numbers for leads.
  - name: 11. Webhooks
    description: Register and manage async job notifications.
paths:
  /api/v1/accounts/usage/:
    get:
      tags:
        - 8. Accounts
      summary: Get account usage
      description: Retrieve credit usage statistics and operation breakdown for an account.
      parameters:
        - name: timezone
          in: query
          required: false
          description: IANA timezone for aggregation.
          schema:
            type: string
            default: UTC
          example: Europe/Kyiv
        - name: period
          in: query
          required: false
          description: Truncation granularity for the usage series.
          schema:
            type: string
            enum:
              - day
              - week
              - month
            default: day
        - name: start_date
          in: query
          required: false
          schema:
            type: string
          example: '2026-05-01'
        - name: end_date
          in: query
          required: false
          schema:
            type: string
          example: '2026-05-31'
        - name: period_month
          in: query
          required: false
          description: Month label for the response (YYYY-MM).
          schema:
            type: string
          example: 2026-05
      responses:
        '200':
          description: Account usage statistics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountUsageResponse'
              example:
                data:
                  period: 2026-05
                  total_credits: 1234
                  breakdown:
                    search_database: 500
                    search_realtime: 200
                    enrich_database: 300
                    enrich_realtime: 100
                    email_find: 134
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    AccountUsageResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            period:
              type: string
              description: Reporting period the stats cover.
            total_credits:
              type: number
              description: Total credits consumed in the period.
            breakdown:
              type: object
              description: Credits consumed per operation type.
              additionalProperties:
                type: number
    Error:
      type: object
      description: Standard error envelope returned for 4xx/5xx responses.
      properties:
        status:
          type: string
          example: error
        status_code:
          type: integer
          example: 400
        detail:
          description: >-
            Human-readable message (string) for most errors, or a field-level
            validation map ({ field: [messages] }) for 400 validation errors.
          example: Insufficient funds in the account.
  responses:
    Unauthorized:
      description: Missing or invalid API token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: error
            status_code: 401
            detail: Authentication credentials were not provided.
    Forbidden:
      description: Authenticated, but the account/plan is not allowed to use this endpoint.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: error
            status_code: 403
            detail: You do not have permission to perform this action.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization
      description: 'Use the required Token prefix. Example: Authorization: Token xxxxxxxxx'

````