---
title: "Insere assinatura"
method: POST
path: "/api/Assinatura"
tags: ["Assinatura"]
---

# Insere assinatura

`POST /api/Assinatura`

Esta API Permite que seja inserido dados na assinatura.

### Requisão 
| **Campo** | **Tipo** | **Descrição** | **Obrigatório** |
|--|--|--|--|
| Id | GUID  | Identificador único da assinatura | Não | 
| ClienteId | GUID  | Identificador único do cliente | Sim |
| ClienteNome | Texto | Nome do cliente relacionado a assinatura, somente para retornar dados | Não | 
| Descricao | Texto | Breve descrição sobre a cobrança | Sim |
| Valor | Numérico  | Valor da cobrança | Sim |
| Periodicidade | Texto | Período o qual a cobrança será enviada ao cliente | Sim |
| DiasGeracaoCobranca | Numérico  | Dias para gerar a cobrança de assinatura | Não | 
| IniciandoEm | Data | Data de início da assinatura | Sim |
| FinalizandoEm | Data | Data de fim da assinatura | Não |
| FormasPagamento | Texto | Forma de pagamento da cobrança | Não |
| ProdutoId | GUID  |Identificador único do produto caso houver | Não |
| Multa | Numérico  | Valor da multa caso haja algum tipo de atraso | Não |
| JurosMes | Numérico | Porcentagem de juros ao mes após o vencimento | Não |
| DescontoAteVencimento | Numérico  | Desconto até a última data do vencimento da assinatura | Não |
| SplitValores | Array | Array especificando o “split” financeiro dos valores arrecadados pelo pagamento para diversas contas do K8Bank, a partir do código de cliente e do valor respectivo | Não |
| ClientePagamentosId | GUID | Id do cliente de pagamento | Não |
| Valor | Número | Valor da assinatura  | Sim |

### Resposta
| **Campo** | **Tipo** | **Descrição** | 
|--|--|--| 
| Id | GUID  | Identificador único da assinatura | 
| ClienteId | GUID  | Identificador único do cliente |
| ClienteNome | Texto | Nome do cliente relacionado a assinatura, somente para retornar dados | 
| 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  | Dias para gerar a cobrança de assinatura |  
| IniciandoEm | Data | Data de início da assinatura |  
| FinalizandoEm | Data | Data de fim da assinatura |  
| 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 | 
| AutoEmiteFormaPagamento | Boleano | Informa se o boleto ou pix foi emitido automaticamente | 
| ClientePagamentosId | GUID | Id do cliente de pagamento |        
| Valor | Numérico | Valor da assinatura |

## Headers

- `Aeskey` string, required

## Request body

- BknBankCobrancasAPIModelsAssinatura — Modelo de Assinaturas
  - `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

## Response `200`

Assinatura criada

- BknBankCobrancasAPIModelsAssinatura — Modelo de Assinaturas
  - `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

- `400` — Dados inválidos da assinatura
- `500` — Erro criando assinatura

---

[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)