> ## 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.

# Ativa, suspende ou cancela o acesso de um assinante a um produto

> Upsert por (parceiro, assinante, produto): chamar novamente com o mesmo assinante/produto e um status diferente atualiza o entitlement existente — não cria duplicado. Por ser um upsert, repetir a mesma chamada é seguro; não há (nem é necessário) um header `Idempotency-Key` — esse mecanismo chegou a ser proposto, mas não está implementado.

Enquanto o SSO não existe, o entitlement fica registrado em uma tabela própria de parceiro no projeto do produto (`partner_subscribers`) — ele **não** cria nem altera a assinatura de nenhuma conta do app oficial. Ver [Modelo de dados](/architecture/data-model).



## OpenAPI

````yaml /platform/openapi.yaml post /entitlements
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:
  /entitlements:
    post:
      tags:
        - Entitlements
      summary: Ativa, suspende ou cancela o acesso de um assinante a um produto
      description: >-
        Upsert por (parceiro, assinante, produto): chamar novamente com o mesmo
        assinante/produto e um status diferente atualiza o entitlement existente
        — não cria duplicado. Por ser um upsert, repetir a mesma chamada é
        seguro; não há (nem é necessário) um header `Idempotency-Key` — esse
        mecanismo chegou a ser proposto, mas não está implementado.


        Enquanto o SSO não existe, o entitlement fica registrado em uma tabela
        própria de parceiro no projeto do produto (`partner_subscribers`) — ele
        **não** cria nem altera a assinatura de nenhuma conta do app oficial.
        Ver [Modelo de dados](/architecture/data-model).
      operationId: setEntitlement
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntitlementRequest'
      responses:
        '200':
          description: Entitlement aplicado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    example: true
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    EntitlementRequest:
      type: object
      required:
        - subscriber_id
        - product
        - status
      properties:
        subscriber_id:
          type: string
          description: Identificador do assinante no sistema do parceiro.
        product:
          type: string
          enum:
            - novelai
            - novelaudio
            - historinhai
        plan:
          type: string
          description: >-
            Plano contratado pelo assinante no parceiro (mapeado para um plano
            interno Googa). Opcional.
          example: reader-plus
        status:
          type: string
          enum:
            - active
            - suspended
            - canceled
    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
  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'
  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

````