Pular para o conteúdo principal

Introdução

O módulo Subscriptions permite configurar no projeto pagamentos recorrentes dos usuários por um conjunto fixo de produtos. Uma assinatura é formada por um conjunto de produtos e um período: a cada N dias, o usuário é cobrado, automaticamente (ou manualmente), pelo valor calculado como a soma dos preços dos produtos incluídos.

O módulo tem duas partes principais:

O aplicativo cliente trabalha com assinaturas por meio da API. Saiba mais na seção da API de assinaturas (abre em uma nova aba).

Como funciona a assinatura​

Ao criar uma assinatura no painel de administração, você escolhe:

  • Conta de pagamento: define como o pagamento será feito. Os tipos de conta são descritos na seção de contas de pagamento (abre em uma nova aba).
  • Período em dias: de quantos em quantos dias o usuário precisa pagar para renovar a assinatura.
  • Lista de produtos incluídos na assinatura: o custo total da assinatura é a soma dos preços atuais desses produtos.

Quando o usuário assina pela API, o sistema:

  1. Cria um registro da assinatura para o usuário.
  2. Retorna um link de pagamento (para stripe e midtrans) ou ativa a assinatura imediatamente, no caso do tipo custom.
  3. Ao fim do período, cobra o próximo pagamento automaticamente (stripe, midtrans) ou aguarda a renovação manual (custom).

Contas de pagamento suportadas​

Você pode conectar à assinatura um dos seguintes tipos de conta de pagamento:

  • Stripe: cobranças periódicas automáticas via Stripe. Depois que a assinatura é criada, a API retorna um link para o primeiro pagamento.
  • Midtrans: cobranças periódicas automáticas via Midtrans. Assim como no Stripe, a API retorna um link de pagamento.
  • Custom: assinatura manual. As cobranças não são feitas automaticamente; o administrador renova e cancela a assinatura no cartão do usuário.
info

O tipo de conta de pagamento determina quais ações estão disponíveis para a assinatura e se ela pode ser cancelada pela API. Assinaturas custom são canceladas apenas no painel de administração, na seção do usuário.

Variação do custo​

O custo da assinatura é a soma dos preços dos produtos que a compõem. Se você alterar o preço de um desses produtos, as assinaturas ativas recalculam o custo automaticamente, e o novo valor passa a valer a partir do próximo período de cobrança.

info

O período atual é sempre pago pelo preço vigente no momento em que começou. Assim, você pode alterar os produtos incluídos e seus preços sem afetar os períodos que o usuário já pagou.