Nesta página
https://api.premepay.com/v1/stores/:id/plans
A Primefy proporciona aos seus usuários a funcionalidade de criar planos de assinatura personalizados. Para personalizar seus planos, primeiro é necessário fazer a criação do seu plano de assinatura. Depois de ter seu plano de assinatura criado, você só precisará vincular os consumidores aderentes, seguindo os passos descritos na seção Assinatura em planos.
A criação do plano permite adição de diferentes períodos de recorrência de pagamento, de acordo com os Códigos de Frenquência para Pagamentos Recorrentes da Primefy**.** Também é possível realizar a parametrização de períodos de carência, período de testes e isenção de pagamento. Isso quer dizer que você pode: • Implementar planos de assinatura durante o período de testes; • Possibilitar que o seu consumidor comece a pagar o plano de assinatura a partir de um prazo específico; • Incluir usuários necessários para ter acesso ao pacote de plano de assinatura, com isenção de pagamento.
• Associar Produtos a um Plano
O Plano de Assinatura pode ser associado a consumidores nacionais e internacionais.
Você pode criar um plano de assinatura utilizando a rota acima.
| Parâmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
name |
string | Nome do plano | Sim |
description |
string | Descrição | Sim |
frequency |
integer | Frequência | Sim |
paymentTypes |
array<integer> | Tipo do pagamento | Sim, pelo menos um |
0 |
Cartão de Crédito | ||
1 |
Boleto Bancário | ||
3 |
Pix | ||
products |
array<object> | Produtos associados ao Plano | Não |
productId |
integer | Id do Produto | Não |
quantity |
decimal | Quantidade de Produtos associado ao Plano | Não |
amount |
decimal | Valor | Sim |
currency |
string | Código alfa da moeda a ser processada. Exemplo: "GBP", "USD", "CAD" | Sim (para Planos Internacionais) |
gracePeriod |
integer | Período de carência | Sim |
maxCharges |
integer | Número de cobranças de acordo com a frequencia. Utilizar o valor 0 para cobranças recorrentes sem período máximo | Não |
chargeDaysBefore |
integer | Define quantos dias antes a cobrança deve ser gerada | Não |
tax |
object | Não | |
mode |
Vide tabela acima com as descrições | Não | |
amount |
Valor da Taxa a ser aplicada | Não |
| ID | Status |
|---|---|
| 0 | Diário |
| 1 | Semanal |
| 2 | Mensal |
| 3 | Trimestral |
| 4 | Semestral |
| 5 | Anual |
Este é um exemplo de como a sua requisição para criar um plano de assinatura deve parecer. Este é o primeiro passo necessário para adicionar seus consumidores em um plano de assinatura recorrente.
200: OK
400: Bad Request
401: Não autorizado
403: Proibido
500: Internal Server Error
Conteúdo Relacionado
<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/a22a31f7-bd92-40af-8042-7685c0c0859a/GET.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/a22a31f7-bd92-40af-8042-7685c0c0859a/GET.png" width="40px" /> GET - Obter Detalhes de Plano de Assinatura
</aside>
<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/52c5ff42-e8bf-45d3-81d1-b6e05786a688/POST.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/52c5ff42-e8bf-45d3-81d1-b6e05786a688/POST.png" width="40px" /> POST - Adicionar Assinatura em Plano
</aside>
