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

# Consultar uso do cliente

> Devolve o total de uso por meter de uma inscrição numa janela de tempo. Sem `from`, a janela começa no primeiro dia do mês corrente (UTC); sem `to`, termina agora. `to` precisa ser depois de `from`.




## OpenAPI

````yaml /api-reference/openapi.pt-BR.json get /metering/usage
openapi: 3.1.0
info:
  title: Infi API
  version: 0.0.1
  description: >
    A API REST do Infi: catálogo, clientes, medição de uso, assinaturas,
    faturas,

    pagamentos e checkout.


    **Autenticação.** Envie a chave secreta em `Authorization: Bearer sk_test_…`

    (sandbox) ou `sk_live_…` (produção). O prefixo da chave decide o ambiente.
    As

    rotas de checkout (`/pay/*`) e `/public/*` não levam chave: rodam no
    navegador

    de quem paga.


    **Idempotência.** Toda requisição que altera dados exige o header

    `Idempotency-Key`. Uma repetição com a mesma chave devolve a resposta
    original

    em vez de executar de novo.


    **Valores.** Dinheiro e quantidades trafegam como texto decimal (`"150.00"`,

    `"0.0001"`), nunca como número de ponto flutuante.


    **Erros.** O corpo traz `error_code` (estável, use para decidir), `message`

    (para pessoas) e `tracer_id` (envie ao suporte). Erros de limite de
    requisições

    e de idempotência vêm aninhados em `error`, com `code` e `request_id`.
servers:
  - url: https://api-sandbox.beinfi.com
    description: Sandbox
  - url: https://api.beinfi.com
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Catálogo
  - name: Clientes
  - name: Medição de uso
  - name: Assinaturas
  - name: Faturas
  - name: Pagamentos
  - name: Checkout
  - name: Cupons
  - name: Cobrança
  - name: Conta
  - name: Webhooks
  - name: Conta de teste
  - name: Rail
  - name: Lojas
paths:
  /metering/usage:
    get:
      tags:
        - Medição de uso
      summary: Consultar uso do cliente
      description: >
        Devolve o total de uso por meter de uma inscrição numa janela de tempo.
        Sem `from`, a janela começa no primeiro dia do mês corrente (UTC); sem
        `to`, termina agora. `to` precisa ser depois de `from`.
      operationId: getUsage
      parameters:
        - name: customerId
          in: query
          required: true
          schema:
            type: string
            format: uuid
          description: Id da inscrição.
        - name: from
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Início da janela (ISO 8601).
        - name: to
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Fim da janela (ISO 8601).
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageReport'
          description: Relatório de uso.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    UsageReport:
      type: object
      required:
        - customerId
        - from
        - to
        - meters
      properties:
        customerId:
          type: string
          format: uuid
          description: Id da inscrição.
        from:
          type: string
          format: date-time
          description: Início da janela.
        to:
          type: string
          format: date-time
          description: Fim da janela.
        meters:
          type: array
          items:
            $ref: '#/components/schemas/MeterUsage'
          description: Um total por meter.
      description: Total de uso por meter de uma inscrição numa janela de tempo.
    MeterUsage:
      type: object
      required:
        - meterId
        - meter
        - unit
        - totalValue
        - eventCount
      properties:
        meterId:
          type: string
          format: uuid
        meter:
          type: string
          description: Chave do meter.
        unit:
          type: string
          description: Unidade do meter.
        totalValue:
          type: string
          description: Quantidade somada no período, em texto decimal.
        eventCount:
          type: integer
          description: Quantos eventos foram registrados.
        totalAmount:
          type:
            - string
            - 'null'
          description: >-
            Valor em dinheiro dessa quantidade pelo preço aplicável. Nulo quando
            o meter não tem preço.
        currency:
          type:
            - string
            - 'null'
          description: Moeda de `totalAmount`.
    Error:
      type: object
      required:
        - message
        - error_code
        - tracer_id
      properties:
        message:
          type: string
          description: Frase legível para pessoas.
        error_code:
          $ref: '#/components/schemas/ErrorCode'
          description: Código estável do erro. Use-o para decidir o que fazer.
        tracer_id:
          type: string
          description: Identificador da requisição. Informe-o ao falar com o suporte.
      description: >-
        O corpo de erro padrão. É plano (sem o envelope `error`) e o
        identificador de rastreio é `tracer_id`.
    ErrorCode:
      type: string
      examples:
        - internal_error
        - validation_failed
        - bad_request
        - unauthorized
        - forbidden
        - not_found
        - conflict
        - rate_limited
      description: >-
        Código estável do erro. A lista não é fechada: além dos códigos
        genéricos, cada área tem os seus (`coupon_expired`,
        `insufficient_balance`, `version_not_draft`, `idempotency_key_reused`…).
        Um código que você não conhece deve ser tratado pelo status HTTP,
        mostrando `message`; não falhe ao ler a resposta.
  responses:
    BadRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Requisição malformada.
    Unauthorized:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Chave ausente ou inválida.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Chave secreta da conta: `Authorization: Bearer sk_test_…` ou
        `sk_live_…`. Use só no servidor.

````