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

# Consulta o consumo do período para reconciliação de billing

> Contagem de exemplares ativos do parceiro no produto, base para a Nota de Débito mensal.

**Simplificação conhecida (v1):** ainda não há histórico por período — a contagem reflete o estado **atual** de entitlements ativos, independente do `period` pedido (o campo `note` da resposta repete esse aviso). Uso real de billing por período exige uma tabela de snapshot/evento, planejada para quando houver parceiro reconciliando Nota de Débito mensal em produção.



## OpenAPI

````yaml /platform/openapi.yaml get /billing-usage
openapi: 3.1.0
info:
  title: Googa Platform API
  version: 1.0.0
  summary: >-
    API compartilhada por todo parceiro Googa — entitlements, status de
    assinante, uso para billing e webhooks. Consumida por NovelAI, HistorinhAI e
    NovelAudio da mesma forma; a lógica de catálogo/conteúdo de cada produto
    vive em sua própria API (ver abas NovelAI / HistorinhAI / NovelAudio).
  description: >-
    Hoje, apenas os apps oficiais (Web/PWA) consomem os produtos Googa,
    autenticando diretamente contra o Supabase de cada produto. Esta API é a
    camada que permite um parceiro terceiro (como uma operadora) integrar sem
    acesso direto ao banco de dados. Ver [Modelo de autenticação sobre
    Supabase](/architecture/supabase-auth-model) para o desenho completo.


    **Status:** os endpoints de token, entitlements, status de assinante,
    billing usage, JWKS e o despacho de webhooks estão implementados no código
    (repo `googa-platform` e Edge Functions de domínio de cada produto); o
    deploy em produção ainda está pendente. O SSO do assinante (`GET
    /oauth2/authorize`) é **planejado — ainda não implementado** e está marcado
    como tal na própria operação.
  contact:
    name: Googa — Suporte a parceiros
    email: developers@googa.com.br
  license:
    name: Uso restrito — ver Política de Uso da API
    url: https://developers.googa.com.br/security/api-usage-policy
servers:
  - url: https://api.googa.com.br/v1
    description: Produção (proposto)
  - url: https://sandbox.googa.com.br/v1
    description: >-
      Sandbox (proposto — ambiente ainda não existe) — dados fictícios, sem
      impacto em billing real
security:
  - partnerOAuth2: []
tags:
  - name: OAuth2
    description: >-
      Emissão e uso de credenciais de parceiro (client credentials) e, no
      futuro, SSO federado do assinante.
  - name: Entitlements
    description: Ativação e suspensão de acesso por assinante e produto.
  - name: Subscriber
    description: Consulta de status do assinante.
  - name: Billing
    description: Consulta de uso para reconciliação e Nota de Débito.
  - name: Keys
    description: >-
      Chave pública (JWKS) usada pelos projetos de produto para verificar o
      token de parceiro.
paths:
  /billing-usage:
    get:
      tags:
        - Billing
      summary: Consulta o consumo do período para reconciliação de billing
      description: >-
        Contagem de exemplares ativos do parceiro no produto, base para a Nota
        de Débito mensal.


        **Simplificação conhecida (v1):** ainda não há histórico por período — a
        contagem reflete o estado **atual** de entitlements ativos, independente
        do `period` pedido (o campo `note` da resposta repete esse aviso). Uso
        real de billing por período exige uma tabela de snapshot/evento,
        planejada para quando houver parceiro reconciliando Nota de Débito
        mensal em produção.
      operationId: getBillingUsage
      parameters:
        - name: product
          in: query
          required: true
          schema:
            type: string
            enum:
              - novelai
              - novelaudio
              - historinhai
        - name: period
          in: query
          required: true
          schema:
            type: string
            example: 2026-07
          description: Período no formato `YYYY-MM`.
      responses:
        '200':
          description: Consumo do período (v1 — snapshot do estado atual).
          content:
            application/json:
              schema:
                type: object
                properties:
                  product:
                    type: string
                  period:
                    type: string
                    example: 2026-07
                  active_count:
                    type: integer
                  note:
                    type: string
                    description: >-
                      Aviso fixo de que a contagem é um snapshot do estado
                      atual, não histórico do período.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  responses:
    BadRequest:
      description: Requisição inválida (corpo, parâmetro ou produto desconhecido).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Credenciais ausentes, inválidas ou expiradas.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Token válido, mas sem o escopo exigido pela operação.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      description: >-
        Formato de erro no estilo OAuth2 (RFC 6749 §5.2) — usado por todos os
        endpoints, não só pelo de token.
      properties:
        error:
          type: string
          example: invalid_request
        error_description:
          type: string
          example: Missing subscriber_id, product, or status
  securitySchemes:
    partnerOAuth2:
      type: oauth2
      description: >-
        Client credentials — para Entitlements (escrita), Subscriber Status e
        Billing (leitura). Cada endpoint exige o escopo correspondente; um token
        sem o escopo recebe `403`.
      flows:
        clientCredentials:
          tokenUrl: https://api.googa.com.br/v1/oauth2/token
          scopes:
            entitlements:write: Ativar/suspender/cancelar entitlements
            subscriber:read: Consultar status de assinante
            billing:read: Consultar uso para billing

````