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

# Visão geral

> Licenças cobram uma quantidade que a sua aplicação reporta — usuários ativos, filiais, dispositivos — e que sobe e desce ao longo do tempo.

> Recursos acumulam eventos ao longo do ciclo. Licenças fazem o oposto: sua aplicação informa **quantos existem agora**, e a Aira cobra **a última quantidade conhecida de cada cliente do escopo do contrato** a cada ciclo.

<Frame>
  <img src="https://mintcdn.com/aira-e93056c6/EK-hZ7zZzaymZBxr/static/license-list.png?fit=max&auto=format&n=EK-hZ7zZzaymZBxr&q=85&s=aff4c65214775410b844e2bd4c2fa500" alt="Aira — Catálogo de licenças" width="4056" height="2380" data-path="static/license-list.png" />
</Frame>

<h2 id="o-que-e-uma-licenca">
  O que é uma licença
</h2>

Licenças representam quantidades que podem variar ao longo do mês, como usuários ativos, filiais ou dispositivos. Em vez de somar acontecimentos, cada leitura declara um estado: "neste momento existem 42".

São duas coisas com nomes parecidos:

1. **A licença** — o que você vende por unidade, cadastrado uma vez no catálogo: um nome, o item de catálogo que vai para a fatura e um **Código** único.
2. **A leitura** — a fotografia de quantas unidades existiam em um momento, sempre identificada pela licença, pelo cliente e pelo momento a que se refere. Junto vem a lista do que foi contado, um item para cada usuário, filial ou dispositivo. É o que a Aira também chama de **saldo**: os dois termos designam a mesma coisa nesta documentação.

A quantidade de licenças em cada dia é definida pela última leitura enviada para o cliente até o fim daquele dia. Se nenhuma leitura for enviada, a última quantidade conhecida é mantida, e é ela que entra no cálculo do ciclo, por quantos ciclos forem necessários.

<Tip>
  Uma licença é o contrário de um contador: ela não cresce sozinha. Cada leitura substitui a anterior como quantidade vigente, para cima ou para baixo.
</Tip>

<Note>
  Quem informa as leituras é a sua aplicação, não a Aira. A área **Licenças** só exibe o que já foi reportado. Veja [Reportar saldos](/licencas/reportar-saldos) para o passo a passo da integração.
</Note>

<br />

<h2 id="como-licencas-se-encaixam-no-fluxo">
  Como licenças se encaixam no fluxo
</h2>

<Steps>
  <Step title="Licença (catálogo)">
    Você cadastra a licença com um nome, um item de catálogo e um código.
  </Step>

  <Step title="Saldos (leituras)">
    Sua aplicação reporta periodicamente quantas unidades cada cliente tem, identificando a licença pelo código.
  </Step>

  <Step title="Plano (precificação)">
    Uma cobrança do tipo **Cobrança por licença** no plano aplica o preço sobre a quantidade reportada.
  </Step>

  <Step title="Fatura">
    O resultado é um item de linha na fatura, com a quantidade cobrada e o detalhamento do preço.
  </Step>
</Steps>

<br />

<h2 id="licenca-ou-recurso">
  Licença ou recurso
</h2>

| Aspecto                | Recursos                                       | Licenças                                                |
| ---------------------- | ---------------------------------------------- | ------------------------------------------------------- |
| Dado de entrada        | eventos de uso que a sua aplicação emite       | uma quantidade que a sua aplicação informa por cliente  |
| Como o número se forma | os eventos do ciclo são filtrados e agregados  | a última leitura conhecida vale como quantidade vigente |
| Ciclo sem novos envios | o cálculo considera apenas os eventos do ciclo | a última quantidade conhecida continua sendo cobrada    |

| Se você cobra por...                                                                   | Use                               |
| -------------------------------------------------------------------------------------- | --------------------------------- |
| Coisas que acontecem e se somam, como chamadas de API, tickets resolvidos e transações | [Recursos](/recursos/visao-geral) |
| Coisas que existem e mudam de quantidade, como usuários ativos, filiais e dispositivos | Licenças                          |

<br />

<h2 id="criar-uma-licenca">
  Criar uma licença
</h2>

<Frame>
  <img src="https://mintcdn.com/aira-e93056c6/EK-hZ7zZzaymZBxr/static/license-create-modal.png?fit=max&auto=format&n=EK-hZ7zZzaymZBxr&q=85&s=e3aa155d68af0cbb8652667427a73cba" alt="Aira — Modal de criação de licença, com Nome, Tipo de item e Código" width="4056" height="2380" data-path="static/license-create-modal.png" />
</Frame>

<Tabs>
  <Tab title="Via Dashboard">
    1. Acesse **Licenças** no menu lateral
    2. Clique em **Adicionar licença**
    3. Preencha:
       * **Nome** — o nome exibido no catálogo e sugerido para a cobrança no plano (ex: "Usuários")
       * **Tipo de item** — o item de catálogo que a cobrança usa na fatura; é possível criar um item novo ali mesmo
       * **Código** — o identificador que a sua aplicação usa para dizer de qual licença está falando (ex: `users`)
    4. Clique em **Adicionar licença**

    <Note>
      **Restrições do Código:**

      * Único por workspace
      * Definido na criação; depois disso o campo fica bloqueado na edição
      * Aceita apenas letras, números, hífens (`-`) e underscores (`_`)
    </Note>
  </Tab>

  <Tab title="Exemplo Prático">
    Um ERP que cobra por usuário ativo cadastra uma única licença:

    * **Nome**: "Usuários ativos"
    * **Tipo de item**: "Licença de usuário"
    * **Código**: `usuarios_ativos`

    Toda madrugada, o ERP informa quantos usuários ativos a Acme tinha naquele momento (42) e quem são esses 42.

    No plano, uma **Cobrança por licença** de `R$ 30,00` por unidade sobre essa licença gera uma linha de `R$ 1.260,00` na fatura do ciclo. Se ninguém informar nada no mês seguinte, a fatura continua cobrando 42.
  </Tab>
</Tabs>

<br />

<h2 id="acompanhar-os-saldos">
  Acompanhar os saldos
</h2>

Abrir uma licença mostra a **Quantidade** atual de cada cliente e a **Última atualização** de cada um.

<Frame>
  <img src="https://mintcdn.com/aira-e93056c6/EK-hZ7zZzaymZBxr/static/license-balances.png?fit=max&auto=format&n=EK-hZ7zZzaymZBxr&q=85&s=29ba267f3cd669ed273be7bba0a020ed" alt="Aira — Saldo atual de cada cliente em uma licença" width="4056" height="2380" data-path="static/license-balances.png" />
</Frame>

<Tip>
  Corrigir uma quantidade é seguro: informar de novo o mesmo momento com o número certo não apaga nada, e sim acrescenta uma versão nova daquele momento. O dia corrigido passa a aparecer marcado como **Corrigido** no histórico.
</Tip>

<br />

<h2 id="arquivar-licencas">
  Arquivar licenças
</h2>

No menu de cada licença, **Arquivar** tira a licença da listagem do catálogo e do seletor de licenças na edição de planos, e bloqueia a edição dos seus dados. Licenças arquivadas exibem o selo **Arquivada** e podem ser reexibidas pelo filtro **Exibir licenças arquivadas**; **Desarquivar** reverte a ação.

<Note>
  Arquivar é uma organização de catálogo, não uma interrupção de cobrança. Leituras continuam sendo aceitas para o código, e cobranças de licença já configuradas em planos continuam sendo faturadas normalmente. O código também continua reservado, e uma nova licença não pode reutilizá-lo.
</Note>

<br />

<h2 id="proximos-passos">
  Próximos passos
</h2>

* [Reportar saldos](/licencas/reportar-saldos) — envie as leituras de quantidade pela API
* [Recursos](/recursos/visao-geral) — para cobranças baseadas em eventos acumulados
* [Planos](/planos/criar-planos) — monte o plano que vai precificar a licença