SopagueDocs
v3

Consultar Assinatura

GET/v2/recurrences/subscriptions/{subscriptionId}

Consulta detalhes completos da assinatura, período contratado, histórico de faturas e último pagamento.

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/{subscriptionId}' \
  --header 'Authorization: Bearer {token}'

Resposta (200 OK)

Exemplo de resposta
{
  "id": "e1f2a3b4-5c6d-7e8f-9a01-234567890abc",
  "status": "ACTIVE",
  "currentPeriodStartsOn": "2026-09-09T10:15:00Z",
  "currentPeriodEndsOn": "2026-10-09T10:15:00Z",
  "nextBillingOn": "2026-10-09T10:15:00Z",
  "customer": {
    "name": "Carlos Eduardo"
  },
  "plan": {
    "name": "Plano Premium Mensal",
    "amount": 49.9
  },
  "billings": [
    {
      "id": "3c2b1a0f-...",
      "status": "PAID",
      "amount": 49.9
    }
  ]
}

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": "SubscriptionId",
    "description": "O SubscriptionId é 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.