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

# PublicApiGetUsageSummary

> GET /api/v1/organizations/{orgId}/billing/credits/usage-summary

Use this endpoint through the Developer API or the matching `firstsales` CLI command when available. Responses use the stable FirstSales public error envelope.


## OpenAPI

````yaml GET /api/v1/organizations/{orgId}/billing/credits/usage-summary
openapi: 3.1.0
info:
  title: FirstSales Developer API
  version: 1.0.0
  description: >-
    Public v1 developer API for FirstSales.io. Generated from live step
    definitions — do not hand-edit.
servers:
  - url: https://sandbox.api.app.firstsales.io
  - url: https://api.app.firstsales.io
security:
  - bearerAuth: []
tags:
  - name: Activities
  - name: Alerts
  - name: API Keys
  - name: Authentication
  - name: Billing
  - name: Blocked Domains
  - name: Campaigns
  - name: Companies
  - name: Connectors
  - name: Contacts
  - name: Copilot
  - name: Dashboard
  - name: Deals
  - name: Direct Email
  - name: Email Authentication
  - name: Inbox
  - name: Knowledge Bases
  - name: Learning
  - name: Offerings
  - name: Organizations
  - name: Product Updates
  - name: Sequence Library
  - name: Signals
    description: >-
      Beta. Find people who comment on or react to LinkedIn posts by a keyword,
      a person or a company page. Each scan costs 10x the scraper cost in
      credits (1 credit = $0.01), capped by the daily budget of the signal. A
      scan that adds no new person is free.
  - name: Suppression
  - name: Team
  - name: Tracking Domains
  - name: Warmup
paths:
  /api/v1/organizations/{orgId}/billing/credits/usage-summary:
    get:
      tags:
        - Billing
      summary: PublicApiGetUsageSummary
      operationId: getBillingUsageSummary
      parameters:
        - name: orgId
          in: path
          required: true
          schema:
            type: string
        - name: days
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 90
            default: 30
        - name: from
          in: query
          required: false
          schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
        - name: to
          in: query
          required: false
          schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicUsageSummaryResponse'
        '400':
          description: Public API error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
        '401':
          description: Public API error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
        '403':
          description: Public API error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
        '404':
          description: Public API error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
        '429':
          description: Public API error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
        '500':
          description: Public API error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
        '503':
          description: Public API error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorEnvelope'
      security:
        - developerKeyBearer: []
components:
  schemas:
    PublicUsageSummaryResponse:
      type: object
      properties:
        daily:
          maxItems: 366
          type: array
          items:
            type: object
            properties:
              date:
                type: string
              total:
                type: number
            required:
              - date
              - total
            additionalProperties: false
        byAction:
          maxItems: 23
          type: array
          items:
            type: object
            properties:
              action:
                type: string
              label:
                type: string
              total:
                type: number
              count:
                type: integer
                minimum: 0
                maximum: 9007199254740991
              displayClass:
                type: string
                enum:
                  - fixed
                  - per-unit
                  - metered
                  - refund
              pct:
                type: number
              unitCost:
                type: number
            required:
              - action
              - label
              - total
              - count
              - displayClass
              - pct
            additionalProperties: false
        totalConsumed:
          type: number
        grossSpend:
          type: number
        totalRefunds:
          type: number
        distinctUsed:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        periodDays:
          type: integer
          minimum: 1
          maximum: 9007199254740991
        clamped:
          type: boolean
      required:
        - daily
        - byAction
        - totalConsumed
        - grossSpend
        - totalRefunds
        - distinctUsed
        - periodDays
        - clamped
      additionalProperties: false
    PublicErrorEnvelope:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            requestId:
              type: string
            details:
              type: object
              additionalProperties: true
          required:
            - code
            - message
            - requestId
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Legacy compatibility bearer scheme for generated consumers.
    developerKeyBearer:
      type: http
      scheme: bearer
      description: FirstSales developer API key bearer token (fs-key-*).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.