Edita plano

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
Atenção
Ao alterar um plano você não altera automaticamente as assinaturas vinculadas a ele.
Para isso você deve listar as assinaturas criadas a partir do plano e atualizá-las uma a uma.

Body Params

description

string

required

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

value

float

required

Defaults to 100.5

Valor padrão do plano.

external_reference

string

Código de referência da loja

frequency

string

required

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

frequency_type

string

enum

required

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

Allowed:

repetitions

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*

installments

int32

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

billing_type

string

enum

Defaults to prepaid

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

Allowed:

billing_day

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.

retry_days

int32

Defaults to 0

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

🚧Atenção

200200

400400

🚧
Atenção