Pular para o conteúdo principal

Atualizar assinatura

Envie apenas os campos que deseja alterar. Assinaturas ACTIVE e PENDING_PAYMENT podem ser atualizadas — CANCELED e EXPIRED devolvem 409.

PATCH/api/v1/subscriptions/:id/
{
"value": 5990,
"cycle": "QUARTERLY",
"nextDueDate": "2026-11-15",
"endDate": "2028-01-01",
"description": "Plano Premium - Atualizado"
}
CampoTipoDescrição
valueintegerNovo valor em centavos, inteiro de 1 a 2147483647. O amount é recalculado
cyclestringNovo ciclo de cobrança
nextDueDatestringNova data de próximo vencimento, YYYY-MM-DD. Hoje ou depois
endDatestringNova data final. Envie "" ou null para remover
descriptionstringNova descrição. Máx. 255 caracteres

As validações de value, nextDueDate, endDate, cycle e tamanho são as mesmas da seção Criar assinatura com cartão, com as mesmas mensagens.

A resposta 200 devolve a assinatura atualizada.

As mudanças valem para as próximas cobranças geradas

Uma cobrança que já existe mantém o valor de quando foi gerada — inclusive se ainda estiver em retentativa (Retentativa de cobrança negada): a retentativa cobra o valor original, e o valor novo entra na cobrança do próximo vencimento.

Campo fora da lista é recusado, não ignorado. A requisição inteira volta 400 e nada é alterado:

{ "status": "error", "message": "Campos não editáveis", "rejectedFields": ["merchantId", "payerName"] }
  • Cartão e callback têm rotas próprias (Trocar o cartão e Atualizar a URL de callback). Dados do pagador não são editáveis — para mudar o pagador, cancele e crie outra assinatura.
  • Corpo vazio ({}) devolve 400 Nenhum campo para alterar.
  • Em PENDING_PAYMENT, a edição serve para corrigir a assinatura antes de o pagador concluir o checkout. A paymentUrl continua a mesma e a tela do pagador passa a mostrar os valores novos.