Os planos podem ser descritos como templates pré-definidos de assinaturas, que facilitam a criação de uma nova assinatura para um cliente.

Para realizar a criação de um plano (plan) são obrigatórios os dados abaixo:

  • Name (Nome do plano);
  • Description (Descrição do plano);
  • Itens (Itens do plano);
  • Interval (Tipo de intervalo: ano, mês ou semana);
  • Interval_Count (Espaçamento entre os intervalos);
  • Payment_Methods (Meios de pagamento aceitos);
  • Start_At (Data de início);
  • Billing_Type (Tipo de cobrança: pré-paga, pós-paga ou dia exato);
  • Installments (Parcelamento);
  • Cycles (Número de ciclos: duração do plano).

📘

Identificador do plano

Todo plano possui um identificador como este: plan_l0y1gJpfwSr0K8gL.
Se você enviar este id na hora de criar uma assinatura, ela será configurada automaticamente com todas as informações deste plano!

🚧

Atenção

Ao alterar um plano você não altera automaticamente as assinaturas vinculadas a ele.
Para isso você deve listar as assinaturas criadas a partir do plano e atualizá-las uma a uma.

Saiba mais sobre planos através de nossa API Reference!