| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Endpoints para consulta e listagem de assinaturas de uma determinada empresa.
- Listar Todas as Assinaturas (Sem Filtro)
Retorna o histórico completo de assinaturas vinculadas à empresa de uma única vez.
⚠️ Atenção: Este endpoint não possui paginação. Dependendo do volume de dados da sua empresa, a resposta pode ser lenta ou sofrer timeout. Para produção, recomendamos fortemente o uso do endpoint de Listagem Filtrada e Paginada.
• Método: GET
• URL: /assinatura/empresa/{ID_EMPRESA} - Listar e Filtrar Assinaturas (Paginado)
Retorna as assinaturas criadas em um intervalo de datas específico, com suporte a paginação e ordenação. Este é o método recomendado para buscas em lote.
Método: GET
URL: /assinatura/empresa/{ID_EMPRESA}/listar?data-inicio=2026-07-16&data-fim=2026-07-16&first=0&limit=9&ordem=DESC>
{first} = Índice utilizado para trazer os resultados a partir do informado. Ex. Se for informado 100, de uma lista de 200, o retorno será a partir de 100.
{limite} = limitador de quantidade máxima de retorno das transações onde o número permitido será 200. Quando não informado o retorno será de 100 registros.
HEADER (FILTROS)
Para buscar assinatura de uma forma mais eficaz e com especificação, é possivel adicionar filtros no header como por exemplo: {"titular":["PROTOCOLO ou DOCUMENTO"],"status":["STATUS_ASSINATURA"]}
Filtro com Protocolo:
filtros: {"titular":["4440"],"status":[]}
Filtro com Documento:
filtros: {"titular":["42029554120"],"status":[]}
Filtro com Status da Assinatura:
filtros: {"titular":[],"status":["ATIVA","PENDENTE","CANCELADA","ENCERRADA","FALHA_PAGAMENTO","DEGUSTACAO"]}
[
{
"id": int,
"empresa": {
"id": "String",
"status": "String",
"cnpj": "String",
"razao_social": "String",
"nome_fantasia": "String",
"telefone": "String",
"e-mail": "String",
"webhook": "String"
},
"titular": {
"id": "String",
"tipo": "String",
"nome": "String",
"cpf": "String",
"e-mail": "String",
"telefone_celular": "String",
"cep": "String",
"endereco": "String",
"número": "String",
"bairro": "String",
"cidade": "String",
"uf": "String"
},
"plano": {
"id": int,
"status": "String",
"descricao": "String",
"valor": double
},
"status": "String",
"metodo": "String",
"data_cadastro": "String",
"data_atualizada": "String",
"data_validade": "String",
"dia_vencimento": int,
"cartão": {
"id": "String",
"holder_name": "String",
"primeiros_dígitos": "String",
"últimos_dígitos": "String",
"expira": "String",
"marca": "String"
},
"ultima_cobranca": {
"id": int,
"empresa": {
"id": "String",
"status": "String",
"cnpj": "String",
"razao_social": "String",
"nome_fantasia": "String",
"telefone": "String",
"e-mail": "String",
"webhook": "String"
},
"cliente": {
"id": "String",
"tipo": "String",
"nome": "String",
"cpf": "String",
"e-mail": "String",
"telefone_celular": "String",
"cep": "String",
"endereco": "String",
"número": "String",
"bairro": "String",
"cidade": "String",
"uf": "String"
},
"data_criacao": "String",
"data_atualização": "String",
"status": "String",
"tipo": "String",
"origem": "String",
"valor": double,
"valor_líquido": double,
"valor_taxa_administração": double,
"valor_taxa_antecipação": double,
"parcelas": int,
"card_holder_name": "String",
"card_first_digits": "String",
"cartão_últimos_dígitos": "String",
"card_expires": "String",
"card_brand": "String",
"nsu": "String",
"nsu_terminal": "String",
"numero_terminal": "String",
"pdv_adquirente": "String",
"pagamentos": [
{
"id": "String",
"status": "String",
"recebedor": {
"id": "String",
"status": "String",
"cnpj": "String",
"razao_social": "String",
"nome_fantasia": "String"
},
"data_compensacao_original": "String",
"data_compensacao": "String",
"valor": double,
"valor_taxa_administração": double,
"valor_taxa_antecipação": double,
"valor_líquido": double,
"parcela": int
},
{
"id": "String",
"status": "String",
"recebedor": {
"id": "String",
"status": "String",
"cnpj": "String",
"razao_social": "String",
"nome_fantasia": "String"
},
"data_compensacao_original": "String",
"data_compensacao": "String",
"valor": double,
"valor_taxa_administração": double,
"valor_taxa_antecipação": double,
"valor_líquido": double,
"parcela": int
},
{
"id": "String",
"status": "String",
"recebedor": {
"id": "String",
"status": "String",
"cnpj": "String",
"razao_social": "String",
"nome_fantasia": "String",
"telefone": "String",
"e-mail": "String",
"webhook": "String"
},
"data_compensacao_original": "String",
"data_compensacao": "String",
"valor": double,
"valor_taxa_administração": double,
"valor_taxa_antecipação": double,
"valor_líquido": double,
"parcela": int
}
],
"itens": []
}
}
]