Crie um Plano

A criação de um plano é uma etapa importante para oferecer opções de assinaturas personalizadas aos seus clientes. Um plano define os termos e condições de cobrança recorrente, permitindo que você padronize e gerencie assinaturas de forma eficiente.

Ao configurar um plano, você utilizará o criar plano. É possível definir diversos parâmetros, como nome, descrição, itens incluídos, intervalo de cobrança e métodos de pagamento aceitos.

📘

Definição de Planos

Um plano é um template pré-definido que facilita a criação de novas assinaturas, estabelecendo um conjunto de regras e condições que serão aplicadas a cada assinatura criada a partir deste plano. Isso inclui detalhes como intervalo de cobrança, métodos de pagamento e itens do plano.

📘

Meios de Pagamento Disponíveis

Aqui você pode saber mais sobre os meios de pagamento disponíveis e suas características.

Após a criação do plano, você receberá um plan_id, que é um identificador único do plano. Todas as mudanças nos status dos planos serão notificadas via webhook, conforme o cadastro que você realizou anteriormente.

🚧

Alterações no Plano

Você poderá realizar alterações em um plano enquanto ele estiver ativo, mantendo o mesmo plan_id e realizando as modificações através dele.

Assim, será possível ajustar detalhes como a descrição do plano, os itens incluídos, o intervalo de cobrança, entre outros.

Forneça os Campos Necessários

É essencial fornecer informações detalhadas ao criar um plano, incluindo:

  • Nome: Identifica o plano.
  • Descrição: Explica o que o plano oferece.
  • Itens: Lista dos produtos ou serviços incluídos no plano.
  • Frequência: Define a frequência da recorrência.
  • Parcelas: Número de parcelas da recorrência.
  • Intervalo: Número de intervalos de acordo com a frequência da recorrência.
  • Métodos de Pagamento: Especifica as formas de pagamento aceitas para o plano.

📘

Itens do Plano

Os itens do plano são utilizados para encapsular informações essenciais relacionadas aos produtos ou serviços oferecidos. Estes itens garantem uma referência clara do que está incluído na assinatura e servem como base para a cobrança recorrente.

Eventos Disponíveis para um Plano

Possuímos uma lista de eventos significativos que podem ocorrer em nossa API em relação aos planos. Confira abaixo:

EventoDescrição
plan.createdOcorre sempre que um plano é criado.
plan.updatedOcorre sempre que um plano é atualizado.
plan.canceledOcorre sempre que um plano é cancelado.
plan.item.createdOcorre sempre que um novo item é adicionado a um plano.
plan.item.updatedOcorre sempre que um item de um plano é atualizado.
plan.item.canceledOcorre sempre que um item de um plano é cancelado.

Status de um Plano

O ciclo de vida de um plano passa por várias etapas, refletindo sua criação, atualização ou cancelamento.

StatusDescrição
activeO plano está ativo e disponível para a criação de novas assinaturas.
inactiveO plano foi inativado e não pode ser utilizado para a criação de novas assinaturas.

Explore detalhadamente os planos por meio de nossa API Reference.