v1
latestOpenAPI 3.1.02026-07-24740156.0 KBRequest body
Consulte os modelos disponíveis clique aqui
Consulte as frequências disponíveis clique aqui
Nome do plano.
Valor do plano que será cobrado de cada assinante.
Para Cartão de crédito, esse será o dia em que a cobrança será efetuada. Para Boleto Bancário, esse será o dia do vencimento do boleto. Ex: 30
Consulte os dias da semana clique aqui
Descrição do plano.
Taxa de assinatura.
Limite de assinaturas que serão permitidas no plano. Caso não seja informado, o plano não terá limite de assinaturas.
Se a cobrança deve ser realizada em até 01 hora, após a assinatura ser realizada Ex: true Esse campo deve ser true caso o Plano for do tipo Fixo.
Se o plano deve cobrar um valor proporcional ao uso na primeira cobrança.
Dias que antecedem o vencimento para envio do boleto (aplicável apenas para boleto). Ex: 5
Quantidade de ciclos para o plano ser encerrado. Caso não seja informado, será considerado ciclo infinito.
URL de notificações de mudança de status do plano.
Dia do vencimento do boleto (aplicável apenas para boleto) Ex: 10
Instrução que deve ser enviada no boleto (aplicável apenas para boleto) Ex: "Pagável até o vencimento"
Multa que deve ser aplicada após o vencimento (aplicável apenas para boleto) Ex: 2.00
Juros que deve ser aplicado após o vencimento (aplicável apenas para boleto) Ex: 2.00
Tipo de desconto a ser aplicado (aplicável apenas para boleto) 1 = valor 2 = Percentual Ex: 1 Informe esse campo apenas se o tipo do plano for personalizado
Quantidade de dias de limite para o desconto (aplicável apenas para boleto). Ex: "30/05/2021"
Valor do desconto (aplicável apenas para boleto). Informar apenas se houver desconto para o boleto. Valor será adicionado em campo separado no registro Ex: 2.00
Se a cobrança vai permitir retentativas. Ex: true
Response
Created