🔗Criar um novo plano

Criação de um novo plano

Para iniciar o processo de criação de um novo plano, é essencial seguir este roteiro detalhado. O procedimento requer o envio de uma solicitação utilizando o método POST. Esta solicitação pode ser realizada de duas maneiras distintas: utilizando dados no formato JSON ou através de multipart/form-data. A escolha entre esses formatos depende da natureza e do formato dos dados que serão transmitidos. Em certos casos, como quando há a necessidade de enviar arquivos em formato binário, o método multipart/form-data é preferível.

URL de Solicitação:

https://api.zsystems.com.br/planos

Cabeçalhos Exigidos para a Requisição:

• Content-Type: Necessário especificar como multipart/form-data ou application/json, adaptado ao método de envio dos dados.

• Authorization: Precisa incluir um 'TokenAPI', precedido por Bearer, para confirmar a autenticação e conceder permissão para realizar a solicitação.

Detalhes dos Parâmetros da Solicitação:

Id	Tipo	Descrição
name		Nome do plano. Ex.: Plano semanal
description		Descrição do plano, falando sobre os beneficios da assinatura
email		Email para qual será enviado a notificação das ações realizadas por este plano
setup_amount		Valor a ser pago no ato da adesão do plano, ex.: 25 = R$ 0.25, 100 = R$ 1.00, 10000 = R$ 100.00
amount		Valor da recorrência, ex.: 25 = R$ 0.25, 100 = R$ 1.00, 10000 = R$ 100.00
grace_period		Período gratuito antes da primeira cobrança
tolerance_period		Período de tolerância quando o pagamento não ocorre
frequency		Frequencia na qual a recorrencia vai acontecer. Nesse campo pode receber 4 valores, sendo eles: ['daily', 'weekly', 'monthly', 'annualy']
interval		Intervalo de tempo que vai acontecer a recorrencia, por exemplo: Se você tiver marcado que a frequencia é semanal e colocar o valor de 1 nesse campo, semanalmente ocorrera a cobrança, mas se você colocar o valor de 2, a cobrança ocorrera de 2 em 2 semanas. No caso de colocar 4 , a cobrança ocorrerá acada 4 semanas
logo		Campo que define se exibir logo do estabelecimento na tela de adesão ou não
currency		Tipo de moeda a ser utilizado, no caso sempre BRL
payment_methods		Método de pagamento. Cartão de crédito ou boleto
plan_expiration_date		Data de expiração do plano
has_expiration		Flag para definir se o plano tem expiração
expire_subscriptions		Flag para definir se a assinatura tem expiração
subscription_duration		Duração da assinatura em meses

Exemplo de requisição:

{
 "name": "Adicionar plano com boleto",
 "description": "Plano sendo adicionado com boleto ",
 "email": "[e-mail]",
 "setup_amount": 50000,
 "amount": 180000,
 "grace_period": "7",
 "tolerance_period": 0,
 "frequency": "monthly",
 "interval": 1,
 "logo": true,
 "currency": "BRL",
 "payment_methods": "boleto",
 "plan_expiration_date": "2021-08-09T03:00:00.000Z",
 "has_expiration": true,
 "expire_subscriptions": true,
 "subscription_duration": "6"
}

Exemplo de resultado:

{
    "success": true,
    "message": "Operação realizada com sucesso",
    "plano": 847
}