---
agentTools:
  projectIndex: https://fix-pay.readme.io/llms.txt
---

# Listar Cobranças de Assinatura

Lista os dados das cobranças das assinaturas.

## Listar Cobranças de Assinatura

Retorna os dados das cobranças de assinatura e um totalizador mostrando a soma de alguns dados, de acordo com os parâmetros passados.

É necessário passar o token gerado no momento em que o usuário realiza o login no header "Authorization".

Abaixo temos um exemplo de como inserir essa informação usando JSON.

```json Headers
{
  "Authorization": "eyXXXXXXXXXXXXXXXXXXXXXXXXXXXXw0"
}
```

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Url Apis Fix Pay",
    "version": "1"
  },
  "servers": [
    {
      "url": "https://apis.fixpay.com.br"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/v1/signature/billingreportsignatures/{groupId}": {
      "get": {
        "summary": "Listar Cobranças de Assinatura",
        "description": "Lista os dados das cobranças das assinaturas.",
        "operationId": "cobrancas-de-assinaturas",
        "parameters": [
          {
            "name": "groupId",
            "in": "path",
            "description": "ID do grupo.",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": true
          },
          {
            "name": "Authorization",
            "in": "header",
            "description": "Token gerado no momento em que o usuário realiza o login no portal. Formato: eyXXXXXXXXXXXXXXXXXXXXXXXXXXXXw0",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "estabelecimento_id",
            "in": "query",
            "description": "ID do estabelecimento.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "cliente_id",
            "in": "query",
            "description": "ID do cliente.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "captura_id",
            "in": "query",
            "description": "ID da captura. Ex.: 16 (Cartão), 23 (Boleto) ou 24 (Pix).",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "plano_id",
            "in": "query",
            "description": "ID do plano.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "assinatura_id",
            "in": "query",
            "description": "ID da assinatuara.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "adimplente",
            "in": "query",
            "description": "Adimplente. Ex.: ADIMPLENTE ou qualquer outro valor para INADIMPLENTE",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "ativo",
            "in": "query",
            "description": "Status. Ex.: ATIVO, PENDENTE, EXPIRADO se outro valor será atibuido assinatura inativa e status EM ABERTO.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "data_primeira_cobranca_inicial",
            "in": "query",
            "description": "Data inicial da primeira cobrança. Ex.: 2023-03-01",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "data_primeira_cobranca_final",
            "in": "query",
            "description": "Data final da primeira cobrança. Ex.: 2023-05-30",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "data_cobranca_inicial",
            "in": "query",
            "description": "Data cobrança inicial. Ex.: 2023-03-01",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "data_cobranca_final",
            "in": "query",
            "description": "Data cobrança final. Ex.: 2023-05-30",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "data_pagamento_inicial",
            "in": "query",
            "description": "Data pagamento inicial. Ex.: 2023-03-01",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "data_pagamento_final",
            "in": "query",
            "description": "Data pagamento final. Ex.: 2023-05-01",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "64a80c137c9e96000c4e1156:64c2b7607acc6f003ada6069"
}
```