Retornar Totalizador de Assinatura

get https://apis.fixpay.com.br/v1/signature/totalizer/{grupoId}

Totalizador de assinaturas.

Retornar Totalizador de Assinatura

Retorna o total de assinaturas, o total de assinaturas onde o cliente é adimplente e/ou inadimplente, a quantidade de ativas, pendentes, expiradas e/ou inativas, e se a forma de pagamento foi feita no pix, cartão ou boleto.

É 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

grupoId

int32

required

Id do grupo. Ex.: 123

Query Params

cliente_id

int32

Id do cliente. Ex.: 123

plano_id

int32

Id do plano. Ex.: 1234

estabelecimento_id

int32

Id do estabelecimento. Ex.: 123

captura_id

int32

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

ativo

string

Situação da assinatura. Ex.: ATIVO, PENDENTE ou EXPIRADO.

adimplente

string

Cumpriu as obrigações financeiras. Ex.: ADIMPLENTE ou INADIMPLENTE

data_criacao_inicial

string

Data de criação inicial. Ex.: 12/03/2023

data_criacao_final

string

Data de criação final. Ex.: 12/06/2023

data_primeira_cobranca_inicial

string

Data da primeira cobrança inicial. Ex.: 12/03/2023

data_primeira_cobranca_final

string

Data da primeira cobrança final. Ex.: 12/06/2023

data_expiracao_inicial

string

Data de expiração inicial. Ex.: 12/03/2023

data_expiracao_final

string

Data de expiração final. Ex.: 12/06/2023

Headers

Authorization

string

required

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

Responses

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://apis.fixpay.com.br/v1/signature/totalizer/grupoId \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Retornar Totalizador de Assinatura

200200

400400