Pular para o conteúdo principal

Produtos

Produtos representam os serviços ou recursos cobráveis da sua organização. Cada produto pode ter múltiplos preços e suporta hierarquia de um nível (produto raiz com filhos/add-ons).

Campos do Produto

CampoDescrição
NomeNome de exibição (1-255 caracteres)
SlugIdentificador único amigável para URL
DescriçãoDetalhes sobre o produto
TipoDetermina o modelo de uso (ver tabela abaixo)
Visibilidadepublic ou private
Label da unidadeNome da unidade (ex: "usuários", "GB")
IncrementoPasso mínimo de quantidade (ex: 10 = quantidades 10, 20, 30...)
ObrigatórioSe é necessário para assinar
URL do siteLink para documentação/página do produto

Tipos de Produto

TipoDescriçãoRecorrência
baseProduto padrão recorrenteRecorrente
addon_quantityAdd-on com preço por quantidadeRecorrente
addon_fixedAdd-on com preço fixoRecorrente
meteredCobrança baseada em uso medidoRecorrente (em arrears)
one_time_fixedTaxa única fixaUma vez
one_time_quantityTaxa única por unidadeUma vez

Hierarquia de Produtos

Produtos suportam um nível de hierarquia:

Produto Raiz (parentProductId = null)
├── Produto filho 1 (add-on)
├── Produto filho 2 (taxa de setup)
└── Produto filho 3 (módulo opcional)

Regras de Hierarquia

  • Não é possível aninhar mais de 1 nível (filhos não podem ter filhos)
  • Produtos filhos herdam a organização/empresa do pai
  • Apenas produtos raiz podem ser adicionados a planos
  • Produtos filhos aparecem como add-ons/opções do produto pai

Status e Ciclo de Vida

draft (rascunho) → active (ativo) → archived (arquivado)
↓ ↑ ↓
DELETE PUBLISH RESTORE
StatusDescrição
draftEm desenvolvimento, não visível para planos
activeDisponível para planos e assinaturas
archivedDesativado; não pode ser usado em novas assinaturas

Regras

  • Arquivar: Não é possível se usado por assinaturas ativas, em trial ou past_due. Desativa todos os preços automaticamente
  • Restaurar: Volta ao status active
  • Publicar: Move de draft para active

Operações em Lote

  • Arquivar em lote: Arquiva múltiplos produtos
  • Deletar em lote: Remove produtos não utilizados em assinaturas
  • Mover para grupo: Move produtos para um grupo de produtos
  • Alterar visibilidade: Muda a visibilidade de múltiplos produtos
  • Alterar empresa: Move produtos para outra empresa

Reordenação

Produtos possuem um campo displayOrder para controlar a ordem de exibição no dashboard e portal. É possível reordenar via drag-and-drop ou API.

Capturas de tela

Lista de produtos

A tela /dashboard/products lista o catálogo com nome, tipo (recorrente, único, metered), preço base, status e visibilidade no portal. Suporta reordenação por drag-and-drop e ações em massa.

Lista de produtos com tipo, preço e visibilidade

Detalhe do produto

A página /dashboard/products/[id] reúne preços vinculados (com moeda e ciclo), itens de serviço fiscal, planos que incluem o produto, eventos de uso e auditoria.

Detalhe de um produto com preços e planos vinculados