SopagueDocs
v3

Listar Planos

GET/v2/recurrences/plans

Lista os planos de recorrência com filtros opcionais de status, unidade de intervalo e paginação.

Cabeçalhos (Headers)

CabeçalhoValorObrigatórioDescrição
AuthorizationBearer <token>SimToken JWT Bearer autenticado

Parâmetros

Exemplo de requisição
curl --request GET \
  --url 'https://api.sopague.com.br/gateway/v2/recurrences/plans' \
  --header 'Authorization: Bearer {token}'

Resposta (200 OK)

Exemplo de resposta
{
  "items": [
    {
      "id": "f5e4d3c2-1b0a-9f8e-7d6c-5b4a3f2e1d0c",
      "name": "Plano Premium Mensal",
      "amount": 49.9,
      "intervalUnit": "MONTH",
      "status": "ACTIVE"
    }
  ],
  "page": 1,
  "pageSize": 20,
  "totalCount": 1,
  "totalPages": 1
}

Erros

As respostas de erro específicas deste endpoint ainda não foram confirmadas. A referência HTTP abaixo apresenta uma possibilidade geral, não um retorno validado nesta rota.

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.