Autenticação: JWT bearer ou chave de API
PUT (substituição completa) quanto PATCH (atualização parcial); prefira PATCH. Se notification_config for incluído no payload, a configuração de notificações aninhada é criada ou atualizada.
Atualizar um plano não altera retroativamente o próximo valor de cobrança dos assinantes já existentes, a menos que você também os cobre novamente. Pagamentos já criados com o valor antigo não são modificados.
Pré-requisitos
- Quem chama precisa estar autenticado contra o vendedor identificado por
seller_id. - O plano precisa pertencer a esse vendedor.
Parâmetros de rota
string
required
UUID unificado da conta do vendedor.
string
required
UUID do plano de assinatura.
Corpo da requisição
Todos os campos são opcionais. Os seguintes são somente leitura e não podem ser alterados:id, account, is_perpetual, metrics, created_at, updated_at.
string
Nome de exibição.
string
Descrição longa.
string
Valor recorrente em centavos de BRL (string).
array
Métodos permitidos (
credit_card, boleto, pix).array
Subconjunto de
payment_methods em que o vendedor absorve a taxa.string
Um dos valores
weekly, biweekly, monthly, bimonthly, quarterly, semiannual, annual.string
Timestamp ISO-8601, ou
null para manter o plano perpétuo.object
Configuração aninhada. Campos:
notify_new_payment_link, days_before_due, notify_on_due_date, days_after_overdue, notify_payment_confirmed. Enviar o objeto cria ou atualiza a linha de configuração.Resposta
200 OK. Retorna o plano completo no mesmo formato de buscar.
Inconsistência conhecida do campo
amount: o valor é tanto enviado quanto retornado como string em centavos, diferente da convenção em centavos inteiros adotada em outros endpoints.