SopagueDocs
v3

Cancelar Assinatura

POST/v2/recurrences/subscriptions/{subscriptionId}/cancel

Cancela a assinatura imediatamente ou agenda o cancelamento para o término do período já pago.

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
{
  "cancelAtPeriodEnd": false,
  "reason": "Solicitado pelo cliente"
}

Resposta (200 OK)

Exemplo de resposta
{
  "id": "e1f2a3b4-5c6d-7e8f-9a01-234567890abc",
  "status": "CANCELED",
  "canceledOn": "2026-09-09T10:20:00Z"
}

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.

Ver validações observadas em homologação

Requisição com corpo JSON vazio ou identificador sintético. O retorno abaixo mostra a validação realizada em homologação.

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": {
    "Idempotency-Key": [
      "The idempotencyKey field is required."
    ]
  },
  "traceId": "00-2876e36501493b6b0c183654c47157cb-43980fe1b365af34-00"
}

Campos da resposta de erro

A tabela reúne os campos presentes nos exemplos acima. Uma resposta HTTP sem corpo não inclui esses campos.