Um plano de assinatura determina as configurações que uma assinatura seguirá, incluindo o valor e o intervalo de cobrança. O serviço de planos permite que você crie os planos que deseja oferecer aos seus clientes para que eles possam assinar seus serviços de maneira conveniente.

Status do plano

Cada plano possui apenas dois estados possíveis:

  • ATIVO (Active): Indica que o plano está ativo e pronto para aceitar assinaturas.
  • INATIVO (Inactive): Indica que o plano está desativado e não está aceitando novas assinaturas.

Endpoints

A API de assinaturas do PagBank disponibiliza os seguintes endpoints para facilitar o gerenciamento dos seus planos:

  • Criar Plano: Crie novos planos de assinatura para oferecer aos seus clientes.
  • Consultar Plano por ID: Consulte detalhes de um plano específico por meio do seu identificador único.
  • Listar Planos: Visualize todos os planos de assinatura criados em sua conta.
  • Alterar Plano: Faça edições e atualizações nos detalhes de um plano existente.
  • Ativar Plano: Torne ativo um plano anteriormente desativado.
  • Inativar Plano: Desative um plano que está atualmente ativo.

Objeto Plano

A API de Assinaturas utiliza o objeto Plano. Para identificar todos os parâmetros, seus respectivos tipos e exemplos de cada parâmetro do objeto, acesse Objeto Plano.