Criar assinatura avulsa

Body Params
string

ID externo de identificação da assinatura. Você pode informar um ID do seu sistema para identificar essa assinatura posteriormente.

string

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

string

A quantidade de vezes que haverá a cobrança dessa assinatura a contar de 0(zero), ou seja, a primeira cobrança será a charge 0, a segunda charge 1 e sucessivamente.

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

Dias de testes para que haja a primeira cobrança(charge).

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.

string

Valor mínimo em centavos que a fatura deve ter para que seja criado a cobrança.

string

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

string
required

Url de notificação de atualizações da assinatura a ser criada.

string
required

Método de pagamento da assinatura. Os valores aceitos são os informados na criação do plano.

string

Nome que aparecerá na fatura do cartão, beneficiário do boleto(aplicável em alguns casos) e na descrição do Pix.

string

Quantos dias de vencimento a cobrança deve ter para pagamento. Obrigatório caso payment_method seja boleto.

card
object

Informações do cartão de crédito para realizar a cobrança. Obrigatório caso payment_method for credit_card.

items
array of objects
items
customer
object
required

Dados do cliente da assinatura

split_rules
array of objects

Regras de divisão dos valores da assinatura

split_rules
increments
array of objects

Incrementos da assinatura

increments
discounts
array of objects

Desconto da assinatura

discounts
Responses

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