API Reference

Criar plano

post
https://{apiUrl}/recurrence/plan

Este recurso cria um plan que poderá ser utilizado futuramente para a criação de uma assinatura.

Body Params
string
required

Descrição do nome do plano. Máximo 80 caracteres.

float
required
Defaults to 100.5

Valor padrão do plano.

string

Código de referência da loja

int32
required

Indica o valor de frequência. Junto com frequency_type define o ciclo de cobrança que a assinatura terá.

string
enum
required

Indica o tipo de frequency. Junto com frequency, exemplos: Para cobrar mensalmente, defina frenquecy = 1 e frequency_type = MONTH

Allowed:
int32

É opcional e utilizado para criar uma assinatura limitada. Indica o número de cobranças que serão repetidos no ciclo de recorrência. Se desejar cobrar no máximo 6 mês de uma recorrência mensal, defina: frequency = 1, frequency_type=MONTH e repetitions = 6

payment_methods
array of strings
required
Defaults to credit_card

Meios de pagamento disponíveis para assinaturas criadas a partir do plano. Valores possíveis: credit_card

payment_methods*
string
enum
Defaults to prepaid

Tipo de cobrança. Valores possíveis: prepaid, postpaid ou exact_day.

Allowed:
int32

Dia disponível para cobrança das assinaturas criadas a partir do plano. Deve ser maior ou igual a 1 e menor ou igual a 28. Obrigatório, caso o billing_type seja igual a exact_day.

int32
Defaults to 0

Quantidade de dias para retentativa da cobrança após a data do processamento da fatura

int32
Defaults to 0

Dias para iniciar a cobrança da assinatura

int32

Quantidade de parcelas permitidas para parcelamento da fatura quando o tipo de pagamento for credit_card

Headers
string
required
Defaults to Bearer

Chave privada gerada no painel, ou encaminhada pelo time de integração

Responses

Updated 3 months ago

Language
Credentials
Header
URL
Response 
 Choose an example:
application/json
Updated 3 months ago