> For the complete documentation index, see [llms.txt](https://paylivre.gitbook.io/guia-de-integracao-via-api-1/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://paylivre.gitbook.io/guia-de-integracao-via-api-1/planos/criar-um-novo-plano.md).

# 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:**

{% code overflow="wrap" %}

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

{% endcode %}

**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:**

<table data-header-hidden><thead><tr><th width="209"></th><th width="123"></th><th></th></tr></thead><tbody><tr><td>Id</td><td>Tipo</td><td>Descrição</td></tr><tr><td>name</td><td></td><td>Nome do plano. Ex.: Plano semanal</td></tr><tr><td>description</td><td></td><td>Descrição do plano, falando sobre os beneficios da assinatura</td></tr><tr><td>email</td><td></td><td>Email para qual será enviado a notificação das ações realizadas por este plano</td></tr><tr><td>setup_amount</td><td></td><td>Valor a ser pago no ato da adesão do plano, ex.: <strong>25 = R$ 0.25</strong>, <strong>100 = R$ 1.00</strong>, <strong>10000 = R$ 100.00</strong></td></tr><tr><td>amount</td><td></td><td>Valor da recorrência, ex.: <strong>25 = R$ 0.25</strong>, <strong>100 = R$ 1.00</strong>, <strong>10000 = R$ 100.00</strong></td></tr><tr><td>grace_period</td><td></td><td>Período gratuito antes da primeira cobrança<br></td></tr><tr><td>tolerance_period</td><td></td><td>Período de tolerância quando o pagamento não ocorre</td></tr><tr><td>frequency</td><td></td><td>Frequencia na qual a recorrencia vai acontecer. Nesse campo pode receber 4 valores, sendo eles: ['daily', 'weekly', 'monthly', 'annualy']</td></tr><tr><td>interval</td><td></td><td></td></tr><tr><td>logo</td><td></td><td>Campo que define se exibir logo do estabelecimento na tela de adesão ou não<br></td></tr><tr><td>currency</td><td></td><td>Tipo de moeda a ser utilizado, no caso sempre BRL</td></tr><tr><td>payment_methods</td><td></td><td>Método de pagamento. Cartão de crédito ou boleto</td></tr><tr><td>plan_expiration_date</td><td></td><td>Data de expiração do plano</td></tr><tr><td>has_expiration</td><td></td><td>Flag para definir se o plano tem expiração</td></tr><tr><td>expire_subscriptions</td><td></td><td>Flag para definir se a assinatura tem expiração</td></tr><tr><td>subscription_duration</td><td></td><td>Duração da assinatura em meses</td></tr></tbody></table>

| 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 |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

**Exemplo de requisição:**

{% code overflow="wrap" %}

```json
{
 "name": "Adicionar plano com boleto",
 "description": "Plano sendo adicionado com boleto ",
 "email": "testecomboleto@email.com",
 "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"
}
```

{% endcode %}

**Exemplo de resultado:**

{% code overflow="wrap" %}

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

{% endcode %}