v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB

Assinatura

Atualiza uma assinatura

Esta API permite que seja atualizado os dados na assinatura, por ID.

Requisão

Campo	Tipo	Descrição	Obrigatório
Id	GUID	Identificador único da assinatura	Sim
ClienteId	GUID	Identificador único do cliente	Não
ClienteNome	Texto	Nome do cliente relacionado a assinatura, somente para retornar dados	Não
Descricao	Texto	Breve descrição sobre a cobrança	Não
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. Não pode ser alterada se já existirem cobranças geradas	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 (1)
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 meuK8, a partir do código de cliente e do valor respectivo	Não
ClientePagamentosId	GUID	Id do cliente de pagamento	Não
Valor	Numérico	Valor da assinatura	Não

(1) - Quando o campo ProdutoId está preenchido a Multa, DescontoAteVencimento e Juros devem estar vazios!

put/api/Assinatura

Headers

Aeskeystring required

Request body

Idstring

Id da assinatura

ClienteIdstring uuid

Id do cliente relacionado a assinatura

ClienteNomestring

Nome do cliente relacionado a assinatura, somente para retornar dados

Descricaostring required

Descrição da assinatura

Valornumber double

Valor da assinatura

Periodicidade da assinatura

DiasGeracaoCobrancainteger

Dias para gerar a cobrança de assinatura

IniciandoEmstring date-time

Data de início da assinatura

FinalizandoEmstring date-time

Data de fim da assinatura

Formas de pagamento da assinatura

ProdutoIdstring uuid

Id do produto da assinatura

Multanumber double

Multa percentual da assinatura

JurosMesnumber double

Juros percentual ao mês da assinatura

DescontoAteVencimentonumber double

Desconto percentual para pagamento até o vencimento da assinatura

AutoEmiteFormaPagamentoboolean

Example request

{
  "Id": "8e5496be-61af-428e-8833-9ddc11ede7af",
  "ClienteId": "a5843418-6f7b-475d-b83f-d4fbe598aeae",
  "ClienteNome": "João Silva",
  "Descricao": "Assinatura Mensal",
  "Valor": 150,
  "Periodicidade": "Mensal",
  "DiasGeracaoCobranca": 5,
  "IniciandoEm": "2026-05-21T10:45:47.4255714-03:00",
  "FinalizandoEm": "2026-06-05T10:45:47.4255714-03:00",
  "FormasPagamento": "Pix",
  "ProdutoId": "4e7f07d5-8908-40e0-95a4-1e9a9169b537",
  "Multa": 0,
  "JurosMes": 0,
  "DescontoAteVencimento": 0,
  "SplitValores": [
    {
      "ClientePagamentosId": "0e235fc3-7388-45a7-975f-a9d139db0038",
      "Valor": 120
    },
    {
      "ClientePagamentosId": "2cde5771-c8cf-46f4-abd4-f624db80ed68",
      "Valor": 30
    }
  ],
  "AutoEmiteFormaPagamento": false
}

Response

object required