v1
latestOpenAPI 3.1.02026-07-2678221359.6 KBCriar assinatura a partir de um Plano
Request body
Id do Plano. Obrigatório se for uma assinatura de plano.
Id do cliente. Obrigatório caso o customer não seja informado.
Quantidade de parcelas aplicáveis quando o método de pagamento da assinatura for cartão de crédito.
Token do cartão gerado pelo checkout.
Meio de pagamento. Valores possíveis: credit_card, boleto, voucher e pix.
Id externo.
Nome da assinatura.
Frequência da recorrência. Valores possíveis: day, week, month ou year.
Número de intervalos de acordo com a propriedade interval entre cada cobrança da assinatura. Ex.: plano mensal = interval_count (1) e interval (month) plano trimestral = interval_count (3) e interval (month) plano semestral = interval_count (6) e interval (month)
Número de intervalo no qual a cobrança é gratuita. Ex.: interval_free (1) e interval (month) a primeira cobrança é gratuita.
Tipo de cobrança. Valores possíveis: prepaid, postpaid ou exact_day.
Objeto chave/valor utilizado para armazenar informações adicionais sobre o pagamento
Response
Assinatura criada com sucesso
Id da assinatura.
Meio de pagamento utilizado na assinatura.
Número de intervalos de acordo com a propriedade interval entre cada cobrança da assinatura. Ex.: plano mensal = interval_count (1)
Id do plano assinado.
Data do próximo faturamento da assinatura.
Quantidade de parcelas aplicádas ao cartão de crédito.
Id externo.
Data de criação da assinatura.
Data de atualização da assinatura.
Dados adicionais da assinatura.