Atualiza uma assinatura

put

https://pagamentos.meuk8.com.br/CobrancasAPI/api/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!

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Dados da assinatura

Modelo de Assinaturas

string

Id da assinatura

ClienteId

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

Criacao

date-time

Data de criação da assinatura

Valor

double

Valor da assinatura

Periodicidade

string

enum

Periodicidade da assinatura

DiasGeracaoCobranca

int32

Dias para gerar a cobrança de assinatura

IniciandoEm

date-time

Data de início da assinatura

FinalizandoEm

date-time

Data de término da assinatura

FormasPagamento

string

enum

Formas de pagamento da assinatura

Allowed:

ProdutoId

uuid

Id do produto da assinatura

Multa

double

Valor

MultaCorrecao

string

enum

Tipo da multa a ser aplicada

Allowed:

JurosMes

double

Valor

JurosCorrecao

string

enum

Tipo do juros a ser aplicado

Allowed:

DescontoAteVencimento

double

Valor

DescontoCorrecao

string

enum

Tipo do desconto a ser aplicado

Allowed:

SplitValores

array of objects

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

SplitValores

AutoEmiteFormaPagamento

boolean

DadosPagamento

object

Modelo de Dados Agregados de Pagamento

Headers

Aeskey

string

required

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

204Assinatura atualizada

400Dados inválidos da assinatura

401Não há permissão para acessar esta assinatura

404Assinatura não encontrada

422Erro de validação

500Id inválido da assinatura ou erro atualizando assinatura