SopagueDocs
v3

Atualizar Plano

PUT/v2/recurrences/plans/{planId}

Cria uma nova versão do plano de recorrência (versionamento imutável). As assinaturas já ativas continuam na versão contratada originalmente.

Cabeçalhos (Headers)

CabeçalhoValorObrigatórioDescrição
AuthorizationBearer <token>SimToken JWT Bearer autenticado
Content-Typeapplication/jsonSimTipo de mídia
Idempotency-Key<guid_ou_string>SimChave de idempotência

Parâmetros

Exemplo de requisição
{
  "name": "Plano Premium Mensal - Reajustado",
  "description": "Reajuste anual de valor",
  "amount": 59.9,
  "currency": "BRL",
  "intervalUnit": "MONTH",
  "intervalCount": 1,
  "billingType": "PREPAID",
  "trialDays": 0,
  "gracePeriodDays": 3,
  "maxRetryAttempts": 3,
  "retryIntervalDays": 1,
  "isPublic": true
}

Resposta (200 OK)

Exemplo de resposta
{
  "id": "c9a8b7d6-1b0a-9f8e-7d6c-5b4a3f2e1d0c",
  "name": "Plano Premium Mensal - Reajustado",
  "amount": 59.9,
  "version": 2,
  "status": "ACTIVE"
}

Erros

As respostas de erro conhecidas estão abaixo. Os retornos observados em homologação estão identificados separadamente dos exemplos documentados; as respostas podem variar conforme o ambiente e a configuração.

Possível resposta HTTP

O 404 pode ocorrer quando a rota ou o recurso solicitado não é encontrado. Confira a URL base, a versão da API, o caminho e o identificador do recurso, quando aplicável.

HTTP/1.1 404 Not Found

Este exemplo ilustra o status HTTP. O corpo da resposta depende da rota e do ambiente.