Listar Cobranças de Assinatura

get

https://apis.fixpay.com.br/v1/signature/billingreportsignatures/{groupId}

Lista os dados das cobranças das assinaturas.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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.

{
  "Authorization": "eyXXXXXXXXXXXXXXXXXXXXXXXXXXXXw0"
}

Path Params

groupId

int32

required

ID do grupo.

Query Params

estabelecimento_id

string

required

ID do estabelecimento.

cliente_id

string

required

ID do cliente.

captura_id

int32

required

ID da captura. Ex.: 16 (Cartão), 23 (Boleto) ou 24 (Pix).

plano_id

string

required

ID do plano.

assinatura_id

string

required

ID da assinatuara.

adimplente

string

required

Adimplente. Ex.: ADIMPLENTE ou qualquer outro valor para INADIMPLENTE

ativo

string

required

Status. Ex.: ATIVO, PENDENTE, EXPIRADO se outro valor será atibuido assinatura inativa e status EM ABERTO.

data_primeira_cobranca_inicial

string

required

Data inicial da primeira cobrança. Ex.: 2023-03-01

data_primeira_cobranca_final

string

required

Data final da primeira cobrança. Ex.: 2023-05-30

data_cobranca_inicial

string

required

Data cobrança inicial. Ex.: 2023-03-01

data_cobranca_final

string

required

Data cobrança final. Ex.: 2023-05-30

data_pagamento_inicial

string

required

Data pagamento inicial. Ex.: 2023-03-01

data_pagamento_final

string

required

Data pagamento final. Ex.: 2023-05-01

Headers

Authorization

string

required

Token gerado no momento em que o usuário realiza o login no portal. Formato: eyXXXXXXXXXXXXXXXXXXXXXXXXXXXXw0

Responses

Listar Cobranças de Assinatura

200200

400400