v1

latestOpenAPI 3.1.02026-07-24740156.0 KB

post/recurrence/v1/plans/

Request body

PlanOptioninteger required

Consulte os modelos disponíveis clique aqui

PlanFrequenceinteger required

Consulte as frequências disponíveis clique aqui

Namestring required

Nome do plano.

Amountnumber double required

Valor do plano que será cobrado de cada assinante.

ChargeDayinteger

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

DayOfWeekinteger

Consulte os dias da semana clique aqui

Descriptionstring

Descrição do plano.

SubscriptionTaxnumber double

Taxa de assinatura.

SubscriptionLimitinteger

Limite de assinaturas que serão permitidas no plano. Caso não seja informado, o plano não terá limite de assinaturas.

IsImmediateChargeboolean

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.

IsProRataboolean

Se o plano deve cobrar um valor proporcional ao uso na primeira cobrança.

DaysBeforeChargeDateExpirationinteger

Dias que antecedem o vencimento para envio do boleto (aplicável apenas para boleto). Ex: 5

BillingCycleinteger

Quantidade de ciclos para o plano ser encerrado. Caso não seja informado, será considerado ciclo infinito.

CallbackUrlstring

URL de notificações de mudança de status do plano.

DaysDueinteger

Dia do vencimento do boleto (aplicável apenas para boleto) Ex: 10

Instructionstring

Instrução que deve ser enviada no boleto (aplicável apenas para boleto) Ex: "Pagável até o vencimento"

PenaltyAmountnumber double

Multa que deve ser aplicada após o vencimento (aplicável apenas para boleto) Ex: 2.00

InterestAmountnumber double

Juros que deve ser aplicado após o vencimento (aplicável apenas para boleto) Ex: 2.00

DiscountTypeinteger

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

DiscountDuestring date

Quantidade de dias de limite para o desconto (aplicável apenas para boleto). Ex: "30/05/2021"

DiscountAmountnumber double

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

IsRetryChargeboolean

Se a cobrança vai permitir retentativas. Ex: true

Response

Created