Criar plano

Body Params
string
required

Nome do plano

string
required

Valor a ser cobrado recorrentemente. Informar em centavos. Ex: R$ 10,00 = 1000

string
Defaults to 30

Prazo, em dias, para cobrança das parcelas. Ex: plano mensal = 30, plano semanal = 7, plano anual = 365.

string

Dias de testes do plano para que haja a primeira cobrança/charge.

payment_methods
array of strings
required

Métodos de pagamento aceitos. Valores disponíveis: pix, boleto, credit_card.

payment_methods*
string

A quantidade de vezes que haverá a cobrança desse plano. Para cartão de crédito a cobrança feita no ato da assinatura não é contata como charge.

string

O número de parcelas que cada charge deve sofrer. Por exemplo: Plano semestral válido por 1 ano, sendo que cada transação será dividia em 6 vezes. Os parâmetros devem ser: days = 180, charges = 1, installments = 6. Boleto e Pix sempre terão installment = 1.

string
Defaults to prepaid

Tipo da cobrança da assinatura. Valor disponíveis: prepaid, pospaid, on_day.

string

Obrigatório se billing_type for on_day.

boolean

Quantos dias antes o cliente será avisado sobre o vencimento da cobrança.

Responses

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json