Assinatura
Atualiza uma assinatura
Esta API permite que sejam atualizados os dados de uma assinatura, por ID.
Requisição
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| Id | GUID | Identificador único da assinatura | Sim |
| ClienteId | GUID | Identificador único do cliente que será cobrado | Sim |
| ClienteNome | Texto | Nome do cliente que será cobrado | Não |
| Descricao | Texto | Breve descrição sobre a assinatura | Sim |
| Valor | Numérico | Valor da assinatura | Sim |
| Periodicidade | Texto | Período no qual a cobrança da assinatura será enviada ao cliente - Todos, Mensal, Semanal, Quinzenal, Bimestral, Trimestral, Semestral, Anual | Sim |
| DiasGeracaoCobranca | Numérico | Dias para gerar a cobrança de assinatura | Não |
| IniciandoEm | Data | Data de início da assinatura. Não pode ser alterada se já existirem cobranças geradas | Sim |
| FinalizandoEm | Data | Data de término da assinatura | Não |
| FormasPagamento | Texto | Forma de pagamento da cobrança | Não |
| ProdutoId | GUID | Identificador único do produto caso haja | Não (1) |
| Multa | Numérico | Multa da assinatura, para pagamento após vencimento | Não |
| MultaCorrecao | Texto | Tipo da correção aplicada sobre a multa - "Percentual", "Valor", "Isento" | Não |
| JurosMes | Numérico | Juros ao mês da assinatura, para pagamento após vencimento | Não |
| JurosCorrecao | Texto | Tipo da correção aplicada sobre os juros - "Percentual", "Valor", "Isento" | Não |
| DescontoAteVencimento | Numérico | Desconto para pagamento até o vencimento da assinatura | Não |
| DescontoCorrecao | Texto | Tipo da correção aplicada sobre o desconto - "Percentual", "Valor", "Isento" | Não |
| SplitValores | Array de Objeto | Array especificando o “split” financeiro dos valores arrecadados pelo pagamento para diversas contas MeuK8, a partir do código de cliente e do valor respectivo | Não |
| ClientePagamentosId | GUID | Identificador único do cliente relacionado ao split | Não |
| Valor | Numérico | Valor de crédito para o participante do split | Não |
(1) - Quando o campo ProdutoId está preenchido a Multa, DescontoAteVencimento e Juros devem estar vazios!
put/api/Assinatura
Request
- Base URLhttps://pagamentos.meuk8.com.br/CobrancasAPI
- URLhttps://pagamentos.meuk8.com.br/CobrancasAPI/api/Assinatura
- AuthOAuth 2PasswordToken URL: /CobrancasAPI/token scopes: BknBankCobrancasAPI
Headers
Aeskeystring required
Request body
Example request
{
"Id": "b4ffe2ec-2028-416e-bb9e-48b3fb8d3a50",
"ClienteId": "d2f1e6ce-621a-491a-b00f-3d25dc2f8e57",
"ClienteNome": "João Silva",
"Descricao": "Assinatura Mensal",
"Criacao": "0001-01-01T00:00:00",
"Valor": 150,
"Periodicidade": "Mensal",
"DiasGeracaoCobranca": 5,
"IniciandoEm": "2026-08-19T10:12:01.355513-03:00",
"FinalizandoEm": "2026-09-03T10:12:01.355513-03:00",
"FormasPagamento": "Pix",
"ProdutoId": "8a6ec9ba-b88b-4305-b52a-f4f8be32cad2",
"Multa": 0,
"MultaCorrecao": "Percentual",
"JurosMes": 0,
"JurosCorrecao": "Percentual",
"DescontoAteVencimento": 0,
"DescontoCorrecao": "Percentual",
"SplitValores": [
{
"ClientePagamentosId": "13d92e92-429d-491a-967e-310bcb3dcb12",
"Valor": 120
},
{
"ClientePagamentosId": "6768bb04-fe09-45e6-b939-4680b0b9d048",
"Valor": 30
}
],
"AutoEmiteFormaPagamento": false
}Response
Assinatura atualizada
System
Changes
No recorded changes to this operation across all 1 revision of this API.