Endpoint: PATCH /subscriptions/seller/{seller_id}/plans/{id}/
Autenticação: JWT bearer ou chave de API
Atualiza um plano de assinatura. O endpoint aceita tanto 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

seller_id
string
required
UUID unificado da conta do vendedor.
id
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.
name
string
Nome de exibição.
description
string
Descrição longa.
amount
string
Valor recorrente em centavos de BRL (string).
payment_methods
array
Métodos permitidos (credit_card, boleto, pix).
payment_methods_no_tax
array
Subconjunto de payment_methods em que o vendedor absorve a taxa.
frequency
string
Um dos valores weekly, biweekly, monthly, bimonthly, quarterly, semiannual, annual.
end_date
string
Timestamp ISO-8601, ou null para manter o plano perpétuo.
notification_config
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.

Erros

StatusQuando
400Validação falhou.
401Token ausente ou inválido.
403Chamador sem vínculo com este vendedor.
404O plano não existe ou não pertence a este vendedor.

Exemplos

curl -X PATCH https://api.dlpay.cloud/subscriptions/seller/SELLER_ID/plans/PLAN_ID/ \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"amount": "5990", "notification_config": {"days_before_due": 5}}'