Editar plano

put

https://api.pagar.me/core/v5/plans/{plan_id}

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

plan_id

string

required

Código do plano.
Formato: plan_XXXXXXXXXXXXXXXX.

Body Params

name

string

required

Nome do plano. Max: 64 caracteres.

status

string

required

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

description

string

Descrição do plano.

shippable

boolean

Indica se o plano oferece entrega.

payment_methods

array of strings

Meios de pagamento disponíveis para assinaturas criadas a partir do plano.
Valores possíveis: credit_card, boleto ou debit_card. Caso nenhum seja informado, o único meio de pagamento disponível por padrão será credit_card

payment_methods

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

minimum_price

int32

Valor mínimo em centavos da fatura.

statement_descriptor

string

Texto exibido na fatura do cartão.
Será aplicado para assinaturas de cartão de crédito criadas a partir do plano.

currency

string

required

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

interval

string

required

Defaults to month

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

interval_count

int32

required

Defaults to 1

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)

trial_period_days

int32

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

billing_type

string

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

billing_days

array of int32s

Dias disponíveis 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.

billing_days

items

array

Itens do plano. Saiba mais sobre um itens do plano

items

metadata

string

Objeto chave/valor utilizado para armazenar informações adicionais sobre o plano.
Saiba mais sobre metadata

Responses

200200

422422