SopagueDocs
v3

Listar Assinaturas

GET/v2/recurrences/subscriptions

Lista assinaturas cadastradas com opções de filtros por status, plano contratado, cliente pagador 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/subscriptions' \
  --header 'Authorization: Bearer {token}'

Resposta (200 OK)

Exemplo de resposta
{
  "items": [
    {
      "id": "e1f2a3b4-5c6d-7e8f-9a01-234567890abc",
      "status": "ACTIVE",
      "nextBillingOn": "2026-10-09T10:15:00Z"
    }
  ],
  "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.