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

# Listar uso e limites disponíveis



## OpenAPI

````yaml /api-reference/openapi.json get /v2/usage
openapi: 3.1.0
info:
  title: Base39 API
  description: Base39 API
  version: 1.0.0
  contact:
    name: Base39 Team
    url: https://base39.com.br
    email: suporte@base39.com.br
  termsOfService: https://base39.com.br/termos
  license:
    name: Proprietary
    url: https://base39.com.br/termos
servers:
  - url: http://localhost:3000
    description: Local
  - url: https://api.dev.base39.cloud
    description: Development
  - url: https://api.base39.com.br
    description: Production
security:
  - OAuth2: []
tags:
  - name: pages
    description: Profiles and reports pages
  - name: pipelines
    description: Pipeline boards (kanban) of pages
  - name: blocks
    description: Blocks operations
  - name: search
    description: Search across content
  - name: targets
    description: Lookup targets via datasets
  - name: CognitoTriggers
    description: Cognito triggers
paths:
  /v2/usage:
    get:
      tags:
        - usage
      summary: Listar uso e limites disponíveis
      operationId: usage_get
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageListOutput'
components:
  schemas:
    UsageListOutput:
      type: object
      properties:
        object:
          type: object
          example: list
        results:
          type: array
          items:
            $ref: '#/components/schemas/UsageMeterOutput'
      required:
        - object
        - results
    UsageMeterOutput:
      type: object
      properties:
        meter:
          type: string
          example: dataset_query.executed.sum
        name:
          type: string
          example: Consultas executadas
        summary:
          $ref: '#/components/schemas/UsageSummaryOutput'
        sources:
          type: array
          items:
            $ref: '#/components/schemas/UsageSourceOutput'
      required:
        - meter
        - name
        - summary
        - sources
    UsageSummaryOutput:
      type: object
      properties:
        limit:
          type: number
          example: 100
          description: Limite total disponível para o meter. -1 indica ilimitado.
        available:
          type: number
          example: 98
          description: Quantidade ainda disponível. -1 indica ilimitado.
        current:
          type: number
          example: 2
          description: Consumo atual no período.
        allowOverage:
          type: boolean
          example: false
          description: Se o meter permite consumo excedente.
      required:
        - limit
        - available
        - current
        - allowOverage
    UsageSourceOutput:
      type: object
      properties:
        subscriptionId:
          type: string
          example: sub_123
        customerId:
          type: string
          example: cus_123
        amount:
          type: number
          example: 100
          description: Limite desta fonte. -1 indica ilimitado.
        available:
          type: number
          example: 98
          description: Disponível nesta fonte. -1 indica ilimitado.
        current:
          type: number
          example: 2
          description: Consumo atual desta fonte no período.
      required:
        - subscriptionId
        - customerId
        - amount
        - available
        - current
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://id.local.base39.cloud/oauth2/authorize
          tokenUrl: https://id.local.base39.cloud/oauth2/token
          scopes:
            profile: Read user profile
            email: Read user email
            openid: OpenID authentication
      description: OAuth2 Authorization Code flow

````