Criar plano

post

https://services.safe2pay.com.br/recurrence/v1/plans/

Esse endpoint permite a criação de planos que podem ser utilizados para criação de assinaturas. Para mais informações, clique aqui.

Body Params

PlanOption

integer

required

Consulte os modelos disponíveis clique aqui

PlanFrequence

integer

required

Consulte as frequências disponíveis clique aqui

Name

string

required

Nome do plano.

Amount

double

required

Valor do plano que será cobrado de cada assinante.

ChargeDay

integer

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

DayOfWeek

integer

Consulte os dias da semana clique aqui

Description

string

Descrição do plano.

SubscriptionTax

double

Taxa de assinatura.

SubscriptionLimit

integer

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

IsImmediateCharge

boolean

Defaults to false

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.

IsProRata

boolean

Defaults to false

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

DaysBeforeChargeDateExpiration

integer

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

BillingCycle

integer

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

CallbackUrl

string

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

DaysDue

integer

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

Instruction

string

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

PenaltyAmount

double

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

InterestAmount

double

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

DiscountType

integer

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

DiscountDue

date

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

DiscountAmount

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

IsRetryCharge

boolean

Defaults to false

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

Responses

201Created

422Unprocessable Entity