Através dessa rota você pode salvar (ou alterar) os dados de um plano no nosso banco de dados para uso posterior.
| Campo(tipo) | Validação | Descrição | Exemplo |
|---|---|---|---|
| name (string) | Título | Plano Fale Paco 100 | |
| amount (integer) | De acordo com gateway | Valor da cobrança, em centavos | R$ 72,90 = 7290 |
| days (integer) | Dias totais de um plano, dentro de uma repetição | 30 | |
| trial_days (integer) | Tempo de teste gratuito, em dias | 10 | |
| charges (integer) | Repetições do ciclo. Exemplo: se plano é mensal e charges = 3, teremos ao total, 3 meses de assinatura | 1 | |
| invoices (integer) | Número de cobranças dentro de uma repetição do plano. Por exemplo: se o plano é de 300 days, com 10 invoices, a cada 30 dias uma nova cobrança deverá ser gerada. O valor do plano também será dividido por 10. | 10 | |
| "use_invoices" | Campo booleano que define se valor do plano e dias serão divididos ou não. Atenção: Caso seja false, o parcelamento poderá ser realizado no cartão, pelo cliente. | true | |
| invoice reminder(integer) | Tempo de aviso de vencimento do boleto, em dias | 5 | |
| payment_methods (array) | Métodos de pagamento aceitos | ||
| payment_methods.*.name(string) | "boleto"/"credit_card/pix" | Nome do método de pagamento | "payment_method": [ "boleto", "credit_card" ] |
| "service_uuid (string)" | Identificador do serviço emissor de notas | e2a4ffa13ec3 | |
| "description (string)" | Descrição | "Plano com emissão de nota fiscal" | |
| aliquot(int) | Alíquota, valor a ser taxado | 10 |
Oferecemos a possibilidade da criação de uma transação no exato momento da efetivação da assinatura, independente do método de pagamento ou da existência de período de teste.
O campo static_gateway é um booleano que determina se as transações das cobranças serão realizadas em um gateway específico ou haverá uma escolha calculada pelo sistema de acordo com as preferências definidas pelo usuário. Para mais informações sobre como o sistema define em qual gateway a cobrança será efetivada, acesse a página de planos: Gateways
Atualmente, utilizamos dois campos dentro do plano para especificar se será possível parcelar o valor total do plano: use_invoices e invoices. O campo use_invoices é um campo booleano que permite ou não o parcelamento.