Desativar Plano
POST/v2/recurrences/plans/{planId}/deactivate
Inativa o plano de recorrência. Assinaturas vigentes continuam ativas e sendo cobradas, mas o plano deixa de aceitar novas contratações.
Cabeçalhos (Headers)
| Cabeçalho | Valor | Obrigatório | Descrição |
|---|---|---|---|
Authorization | Bearer <token> | Sim | Token JWT Bearer autenticado |
Idempotency-Key | <guid_ou_string> | Sim | Chave de idempotência |
Parâmetros
Exemplo de requisição
curl --request POST \
--url 'https://api.sopague.com.br/gateway/v2/recurrences/plans/{planId}/deactivate' \
--header 'Authorization: Bearer {token}'Resposta (200 OK)
Exemplo de resposta
{
"id": "f5e4d3c2-1b0a-9f8e-7d6c-5b4a3f2e1d0c",
"status": "INACTIVE"
}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-10885425500b702f58468fa2f7ea76b5-dd30a8c88b7d4289-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.
