---
title: "Consulta Assinaturas"
method: GET
path: "/api/Assinatura"
tags: ["Assinatura"]
---

# Consulta Assinaturas

`GET /api/Assinatura`

Esta API permite realizar consultas das assinaturas em massa por descrição, cliente e periodicidade.

### Requisição
| **Campo** | **Tipo** | **Descrição** | **Obrigatório** |
|--|--|--|--| 
| DescricaoContains | Texto | Descrição da assinatura, aceita consulta parcial | Não | 
| ClienteNomeContains | Texto | Nome do cliente da assinatura, aceita consulta parcial | Não | 
| Periodicidade | Texto | Periodicidade da assinatura | Não |
| Start | Número | Posição do início da consulta | Não |
| Size | Número | Quantidade de itens retornados | Não |

### Resposta 
| **Campo** | **Tipo** | **Descrição** | 
|--|--|--| 
| Criacao |Data  | Data em que a cobrança foi criada | 
| Id | GUID | Identificador único da assinatura | 
| ClienteId | GUID | Identificador único do cliente | 
| ClienteNome | Texto | Nome do cliente que será realizada a cobrança | 
| Descricao | Texto | Breve descrição sobre a cobrança | 
| Valor | Numérico  | Valor da cobrança | 
| Periodicidade | Texto | Período o qual a cobrança será enviada ao cliente| 
| DiasGeracaoCobranca | Numérico  | Tempo destinado a geração da cobrança | 
| IniciandoEm | Data | Tempo o qual ela vai começar a ser enviada ao cliente | 
| FinalizandoEm | Data | Tempo o qual ela não vai mais ser enviada ao cliente | 
| FormasPagamento | Texto | Forma de pagamento da cobrança | 
| ProdutoId | GUID  |Identificador único do produto caso houver  | 
| Multa | Numérico  | Valor da multa caso haja algum tipo de atraso | 
| JurosMes | Numérico | Porcentagem de juros ao mes após o vencimento | 
| DescontoAteVencimento | Numérico  | Desconto até a última data do vencimento da assinatura | 
| SplitValores | Array | Array especificando o “split” financeiro dos valores arrecadados pelo pagamento para diversas contas do meuK8, a partir do código de cliente e do valor respectivo | 
| ClientePagamentosId | Texto | Id do cliente de pagamento | 
| Valor | Número | Valor da assinatura |

## Query parameters

- `DescricaoContains` string
- `ClienteNomeContains` string
- `Periodicidade` 'Todos' | 'Mensal' | 'Semanal' | 'Quinzenal' | 'Bimestral' | 'Trimestral' | 'Semestral' | 'Anual'
- `Start` integer
- `Size` integer

## Headers

- `Aeskey` string, required

## Response `200`

Assinaturas consultadas com sucesso

- BknBankCobrancasAPIModelsAssinaturaResponse[]
  - `Criacao` string, date-time — Data de criação da assinatura
  - `Id` string — Id da assinatura
  - `ClienteId` string, uuid — Id do cliente relacionado a assinatura
  - `ClienteNome` string — Nome do cliente relacionado a assinatura, somente para retornar dados
  - `Descricao` string, required — Descrição da assinatura
  - `Valor` number, double — Valor da assinatura
  - `Periodicidade` 'Todos' | 'Mensal' | 'Semanal' | 'Quinzenal' | 'Bimestral' | 'Trimestral' | 'Semestral' | 'Anual' — Periodicidade da assinatura
  - `DiasGeracaoCobranca` integer — Dias para gerar a cobrança de assinatura
  - `IniciandoEm` string, date-time — Data de início da assinatura
  - `FinalizandoEm` string, date-time — Data de fim da assinatura
  - `FormasPagamento` 'Nenhum' | 'Boleto' | 'Cartao' | 'Pix' | 'Manual' | 'Protesto' | 'SaldoWebConta' — Formas de pagamento da assinatura
  - `ProdutoId` string, uuid — Id do produto da assinatura
  - `Multa` number, double — Multa percentual da assinatura
  - `JurosMes` number, double — Juros percentual ao mês da assinatura
  - `DescontoAteVencimento` number, double — Desconto percentual para pagamento até o vencimento da assinatura
  - `SplitValores` BknBankCobrancasAPIModelsSplitAssinaturaRequest[] — Definicao de split para a assinatura
    - `ClientePagamentosId` string, uuid — Id da produto associado ao split
    - `Valor` number, double — Valor nominal de credito para o participante
  - `AutoEmiteFormaPagamento` boolean

## Other responses

- `500` — Erro efetuando a consulta

---

[API](https://skmtc.net/meuk8/apis/k8-fintech.md) · [All operations](https://skmtc.net/meuk8/apis/k8-fintech/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/meuk8/k8-fintech/revisions/14db4977f490/schema)