Consultar Plano
GET/v2/recurrences/plans/{planId}
Consulta os detalhes da versão ativa de um plano de recorrência cadastrado.
Cabeçalhos (Headers)
| Cabeçalho | Valor | Obrigatório | Descrição |
|---|---|---|---|
Authorization | Bearer <token> | Sim | Token JWT Bearer autenticado |
Parâmetros
Exemplo de requisição
curl --request GET \
--url 'https://api.sopague.com.br/gateway/v2/recurrences/plans/{planId}' \
--header 'Authorization: Bearer {token}'Resposta (200 OK)
Exemplo de resposta
{
"id": "f5e4d3c2-1b0a-9f8e-7d6c-5b4a3f2e1d0c",
"externalId": "PLANO-GOLD-01",
"name": "Plano Premium Mensal",
"amount": 49.9,
"currency": "BRL",
"intervalUnit": "MONTH",
"intervalCount": 1,
"billingType": "PREPAID",
"version": 1,
"status": "ACTIVE",
"createdOn": "2026-09-09T10:00: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.
[
{
"tag": "PlanId",
"description": "PlanId é obrigatório."
}
]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.
