Editar plano

put

https://api.mundipagg.com/core/v1/plans/{plan_id}

Com o verbo HTTP PUT, através do identificador do plano (plan_id) é possível atualizar os dados do plano.

Path Params

plan_id

string

required

Código do Plano.
Formato: plan_XXXXXXXXXXXXXXXX.

Body Params

name

string

required

Nome do plano. Max: 64 caracteres.

description

string

Descrição do plano. Max: 256 caracteres

currency

string

required

Moeda. Valores possíveis: BRL, ARS, BOB, CLP, COP , MXN, PYG, USD , UYU e EUR.

interval

string

required

Intervalo da recorrência. Valores possíveis: day, week, month ou year

interval_count

int32

required

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)

billing_type

string

required

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

billing_days

array of int32s

Dias disponíveis para cobrança. Obrigatório, caso o billing_type seja igual a exact_day.

billing_days

installments

array of int32s

Opções de parcelamento disponíveis para assinaturas criadas a partir do plano.
Caso não seja informado, o plano irá disponibilizar apenas assinaturas com pagamentos à vista.

installments

statement_descriptor

string

Texto exibido na fatura do cartão. Será aplicado caso o método de pagamento da assinatura seja cartão de crédito. Max: 22 caracteres.

minimum_price

int32

Valor mínimo em centavos do plano.

status

string

required

Status do plano. Valores possíveis: active, inactive ou deleted

shippable

boolean

Defaults to false

Indica se o produto oferecido pelo plano é entregável. Por exemplo, planos relacionados a serviços não possuem dados para entrega.

payment_methods

array of strings

required

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

payment_methods*

trial_period_days

int32

Dias de teste. A assinatura será iniciada após o término deste período.

Responses

200200

404404