API RecebeAqui
Introdução
Comece por aqui Autenticação Limite de Requisições Webhook
Checkout
POST Criar Checkout GET Consultar Checkout PUT Cancelar Checkout POST Criar Checkout transparente
Gerenciamento de Pagamentos
Cancelar Pagamento Realizado
Assinaturas/Recorrências
POST Criar Recorrência GET Consultar Recorrências GET Pagamentos da Recorrência
GET

Consultar Assinaturas/Recorrências

Consulte as assinaturas (cobranças recorrentes) da sua conta. Você pode filtrar por ID, referência externa ou status, e os resultados são paginados.

Endpoint

GET /api/subscription

Parâmetros da Consulta

Parâmetro Tipo Obrigatório Descrição
id string Não ID da assinatura

ID gerado pela RecebeAqui, use para buscar uma assinatura específica

externalReference string Não Referência externa

Código definido pelo seu sistema ao criar um checkout, use para localizar uma assinatura específica

status string Não Filtro por status

ATIVA, INTERROMPIDA, FINALIZADA, PAUSADA

pageNumber int Não Número da página para paginação

(padrão: 1)

itemsPerPage int Não Itens por página

(padrão: 150, máximo: 150)

Exemplos de Requisição

# Listar todas as assinaturas ativas
curl -X GET "https://api.recebeaqui.com/v2/api/subscription?status=ativa" \
  -H "Authorization: Bearer {seu_token_de_api}"

# Consultar assinatura específica por ID
curl -X GET "https://api.recebeaqui.com/v2/api/subscription?id=123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer {seu_token_de_api}"

# Consultar por referência externa
curl -X GET "https://api.recebeaqui.com/v2/api/subscription?externalReference=assinatura-12345" \
  -H "Authorization: Bearer {seu_token_de_api}"
// Listar assinaturas ativas
const activeSubscriptions = await fetch('https://api.recebeaqui.com/v2/api/subscription?status=ativa', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer {seu_token_de_api}',
    'Content-Type': 'application/json'
  }
});

// Consultar assinatura específica
const subscriptionById = await fetch('https://api.recebeaqui.com/v2/api/subscription?id=123e4567-e89b-12d3-a456-426614174000', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer {seu_token_de_api}',
    'Content-Type': 'application/json'
  }
});

const data = await activeSubscriptions.json();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "{seu_token_de_api}");

// Listar assinaturas ativas
var activeSubscriptions = await client.GetAsync("https://api.recebeaqui.com/v2/api/subscription?status=ativa");

// Consultar assinatura específica
var subscriptionById = await client.GetAsync("https://api.recebeaqui.com/v2/api/subscription?id=123e4567-e89b-12d3-a456-426614174000");

var content = await activeSubscriptions.Content.ReadAsStringAsync();

Resposta de Sucesso

Em caso de sucesso (código 200), você receberá uma lista paginada de assinaturas:

{
  "itemsPerPage": 2,
  "pageNumber": 1,
  "subscriptions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "externalReference": "assinatura-12345",
      "frequency": "MONTHLY",
      "status": "ativo",
      "maxCycles": 12,
      "value": 99.90
    },
    {
      "id": "456e7890-e89b-12d3-a456-426614174001",
      "externalReference": "assinatura-67890",
      "frequency": "WEEKLY",
      "status": "ativo",
      "maxCycles": 0,
      "value": 29.90
    }
  ]
}

Status de Assinaturas

Status Descrição
Ativa Assinatura em andamento, com cobranças sendo processadas.
Interrompida Assinatura suspensa temporariamente, podendo ser retomada.
Finalizada Assinatura encerrada de forma definitiva, não gera mais cobranças.
Pausada Assinatura concluída automaticamente após atingir o número máximo de ciclos.