Atualiza uma assinatura

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

Requisão

CampoTipoDescriçãoObrigatório
IdGUIDIdentificador único da assinaturaSim
ClienteIdGUIDIdentificador único do clienteNão
ClienteNomeTextoNome do cliente relacionado a assinatura, somente para retornar dadosNão
DescricaoTextoBreve descrição sobre a cobrançaNão
ValorNuméricoValor da cobrançaSim
PeriodicidadeTextoPeríodo o qual a cobrança será enviada ao clienteSim
DiasGeracaoCobrancaNuméricoDias para gerar a cobrança de assinaturaNão
IniciandoEmDataData de início da assinatura. Não pode ser alterada se já existirem cobranças geradasSim
FinalizandoEmDataData de fim da assinaturaNão
FormasPagamentoTextoForma de pagamento da cobrançaNão
ProdutoIdGUIDIdentificador único do produto caso houverNão (1)
MultaNuméricoValor da multa caso haja algum tipo de atrasoNão
JurosMesNuméricoPorcentagem de juros ao mes após o vencimentoNão
DescontoAteVencimentoNuméricoDesconto até a última data do vencimento da assinaturaNão
SplitValoresArrayArray especificando o “split” financeiro dos valores arrecadados pelo pagamento para diversas contas do meuK8, a partir do código de cliente e do valor respectivoNão
ClientePagamentosIdGUIDId do cliente de pagamentoNão
ValorNuméricoValor da assinaturaNão

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Dados do assinatura

Modelo de Assinaturas

string

Id da assinatura

uuid

Id do cliente relacionado a assinatura

string

Nome do cliente relacionado a assinatura, somente para retornar dados

string
required

Descrição da assinatura

double

Valor da assinatura

string
enum

Periodicidade da assinatura

int32

Dias para gerar a cobrança de assinatura

date-time

Data de início da assinatura

date-time

Data de fim da assinatura

string
enum

Formas de pagamento da assinatura

Allowed:
uuid

Id do produto da assinatura

double

Multa percentual da assinatura

double

Juros percentual ao mês da assinatura

double

Desconto percentual para pagamento até o vencimento da assinatura

SplitValores
array of objects

Definicao de split para a assinatura

SplitValores
boolean
Headers
string
required
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json