venda recorrente

Introdução à API de Venda Recorrente
Segurança e Autenticação
Bibliotecas
- Utilizando a SDK-PHP
Webhooks
Documentação Interativa
Versionamento e Manutenção
Ambientes para Testes
Endpoints da API Venda Recorrente
customers
plans
products
payment_methods
- Retorna um método de pagamento específico através do ID.get
- Lista todos os métodos de pagamento disponíveis.get
discounts
subscriptions
product_items
periods
bills
bill_items
- Retorna um item específico através do ID.get
charges
transactions
payment_profiles
usages
- Remove um período de utilização através do ID.delete
- Cria um novo registro de utilização.post
invoices
movements
- Remove um movimento financeiro pendente através de um ID.delete
- Cria um novo movimento financeiro de ajuste.post
messages
export_batches
import_batches
issues
notifications
merchants
merchant_users
roles
- /v1/rolesget
user
- /v1/users/currentget
affiliates
partner
- Retorna uma lista de contas do parceiro.get
- Cadastra uma nova conta do parceiropost
public
- Cadastra um novo perfil de pagamentopost

Atualiza um item existente.

put https://app.vindi.com.br/api/v1/product_items/{id}

É possível atualizar um item em uma assinatura existente, porém isso não causará nenhum reflexo imediato nas faturas já emitidas. Alterações em um item serão aplicadas apenas na próxima fatura gerada, porém de qualquer forma é possível cancelar e reemitir uma fatura já gerada.

Precificação

Informe o parâmetro pricing_schema apenas se quiser alterar a precificação atual do item. Consulte este artigo para mais informações sobre o cálculo da precificação.

URL Expired

The URL for this request expired after 30 days.

🚧
Atenção
Alguns links acima podem estar direcionados a nossa pagina de atendimento, nesse caso sugerimos que utilize o campo "Pesquisa" deste portal para ter acesso a informação mais recente.

Path Params

int32

required

ID do item que deverá ser atualizado.

Body Params

body

string

JSON com novos atributos do item.

status

string

required

Status do item

cycles

int32

Número de ciclos de recorrência onde o produto será aplicado a partir do momento de sua criação. Nulo significa duração ilimitada

quantity

int32

Quantidade do produto incluído na assinatura. Se não for informado, o valor '1' será utilizado

pricing_schema

object

Responses

Response body

object

int32

required

ID do item

status

string

required

Status do item

active inactive deleted

uses

int32

Número de ciclos de recorrência que utilizaram o produto.

cycles

int32

Número de ciclos de recorrência onde o produto será aplicado a partir do momento de sua criação. Nulo significa duração ilimitada

quantity

int32

Quantidade do produto incluído na assinatura. Se não for informado, o valor '1' será utilizado

created_at

string

required

Data e hora da criação do item

updated_at

string

required

Data e hora da última atualização do item

product

object

required

int32

required

ID do produto

name

string

required

Nome do produto

code

string

Código externo do produto

pricing_schema

object

string

required

ID do esquema de precificação

short_format

string

required

Descrição da precificação gerada automaticamente

price

number

required

Preço base

minimum_price

number

Preço mínimo

schema_type

string

required

Tipo de cálculo da precificação

flat per_unit step_usage volume_usage tier_usage

pricing_ranges

array of objects

Lista de faixas de precificação

pricing_ranges

object

string

required

ID do faixa de precificação

start_quantity

int32

required

Início da faixa

end_quantity

int32

Término da faixa. Opcional apenas para a última

price

number

required

Preço da unidade ou da faixa, dependendo do tipo escolhido

overage_price

number

Preço unitário do excedente da faixa

created_at

string

required

Data e hora do cadastro do esquema de precificação

discounts

array of objects

Lista de descontos ativos. Descontos já aplicados não serão retornados

discounts

object

int32

required

ID do desconto

discount_type

string

required

Tipo do desconto

percentage amount quantity

percentage

number

Valor numérico para porcentagem de 0.01 até 100

amount

number

Valor para desconto fixo

quantity

int32

Número para desconto por quantidade

cycles

int32

Número de ciclos de recorrência onde o desconto será aplicado a partir do momento de sua criação. Nulo significa desconto por tempo indefinido

Response body

object

errors

array of objects

errors

object

string

required

Chave identificadora do erro

parameter

string

Parâmetros do erro

message

string

required

Detalhes do erro

Response body

object

errors

array of objects

errors

object

string

required

Chave identificadora do erro

parameter

string

Parâmetros do erro

message

string

required

Detalhes do erro

Response body

object

errors

array of objects

errors

object

string

required

Chave identificadora do erro

parameter

string

Parâmetros do erro

message

string

required

Detalhes do erro

Updated about 1 year ago

Retorna um item da assinatura específico através do ID.

Remove um item através do ID.

Did this page help you?

Language

Credentials

Basic

base64

URL


xxxxxxxxxx
12
1
curl --request PUT \
2
     --url https://app.vindi.com.br/api/v1/product_items/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "status": "active",
8
  "pricing_schema": {
9
    "schema_type": "flat"
10
  }
11
}
12
'


xxxxxxxxxx
41
}
1
{
2
  "id": 0,
3
  "status": "active",
4
  "uses": 0,
5
  "cycles": 0,
6
  "quantity": 0,
7
  "created_at": "string",
8
  "updated_at": "string",
9
  "product": {
10
    "id": 0,
11
    "name": "string",
12
    "code": "string"
13
  },
14
  "pricing_schema": {
15
    "id": "string",
16
    "short_format": "string",
17
    "price": 0,
18
    "minimum_price": 0,
19
    "schema_type": "flat",
20
    "pricing_ranges": [
21
      {
22
        "id": "string",
23
        "start_quantity": 0,
24
        "end_quantity": 0,
25
        "price": 0,

Updated about 1 year ago

Retorna um item da assinatura específico através do ID.

Remove um item através do ID.

Did this page help you?

venda recorrente
Introdução à API de Venda Recorrente
Especificações Técnicas
Paginação
Buscas e Filtros
Rate Limit
Quais são os códigos de retorno HTTP da API
Primeiros Passos
Criando uma chave de acesso
Segurança e Autenticação
Bibliotecas
Utilizando a SDK-PHP
Webhooks
Payload dos webhooks
Webhooks Segurança e Testes
Webhooks Conteúdo da Requisição e Eventos
Webhooks Retentativas
Webhooks Formatos e métodos de envio
Webhooks Configurações
IPs utilizados na Vindi para enviar webhooks
Boas Práticas Webhook
Documentação Interativa
Versionamento e Manutenção
Endpoints da API Venda Recorrente
customers
Reverte o arquivamento de um cliente.post
Cadastra um novo cliente.post
Retorna uma lista de clientes.get
Arquiva um cliente específico através do ID.delete
Atualiza um cliente existente através do ID.put
Retorna um cliente específico através do ID.get
plans
Retorna os itens do plano através de seu ID.get
Cadastra um novo plano.post
Retorna uma lista de planos.get
Atualiza um plano existente.put
Retorna um plano específico através do ID.get
products
Cadastra um novo produto.post
Retorna uma lista de produtos.get
Atualiza um produto existente.put
Retorna um produto específico através do ID.get
payment_methods
Lista todos os métodos de pagamento disponíveis.get
Retorna um método de pagamento específico através do ID.get
discounts
Cria um desconto em uma assinatura existente.post
Cancela um desconto através do ID.delete
Retorna uma desconto específico através do ID.get
subscriptions
Retorna os itens de uma assinatura através do seu ID.get
Cria uma nova assinatura.post
Retorna uma lista de assinaturas.get
Renova uma assinatura existente.post
Cancela uma assinatura através do ID.delete
Atualiza uma assinatura existente.put
Retorna uma assinatura específica através do ID.get
Reativa uma assinatura cancelada através do ID.post
product_items
Cadastra um novo item em uma assinatura existente.post
Remove um item através do ID.delete
Atualiza um item existente.put
Retorna um item da assinatura específico através do ID.get
periods
Retorna uma lista de períodos.get
Retorna uma lista de registros de utilização para um período específico.get
Emite uma nova fatura baseada em um período.post
Atualiza um período existente.put
Retorna um período específico através do ID.get
bills
Retorna os itens de fatura através de seu ID.get
Cria uma nova fatura avulsa.post
Retorna uma lista de faturas.get
Aprova uma fatura através do ID.post
Antecipa imediatamente a cobrança de uma fatura através do ID.post
Gera notas fiscais de uma fatura através do ID.post
Cancela uma fatura através do ID.delete
Atualiza uma fatura existente.put
Retorna uma fatura específica através do ID.get
bill_items
Retorna um item específico através do ID.get
charges
Retorna uma lista de cobranças.get
Reemite uma cobrança existente usando outro método de pagamento.post
Efetua uma nova tentativa em uma cobrança existente.post
Estorna uma cobrança existente.post
Cancela uma cobrança existente.delete
Atualiza uma cobrança existente.put
Retorna uma cobrança específica através do ID.get
Revisa manualmente uma cobrança suspeita de fraude.post
Captura manualmente uma cobrança previamente autorizada.post
transactions
Retorna uma lista de transações de recuperação de inadimplência.get
Insere uma nova transação manual.post
Retorna uma lista de transações.get
Atualiza uma transação existente.put
Retorna uma transação específica através do ID.get
payment_profiles
Verifica a validade de um perfil de pagamento existente através do ID.post
Cadastra um novo perfil de pagamento para um cliente existente.post
Retorna uma lista de perfis de pagamento.get
Inativa um perfil de pagamento existente através do ID.delete
Atualiza um perfil de pagamento existente através do ID.put
Retorna um perfil de pagamento específico através do ID.get
usages
Cria um novo registro de utilização.post
Remove um período de utilização através do ID.delete
invoices
Emite uma nota fiscal avulsa.post
Retorna uma lista de notas fiscais.get
Efetua uma retentativa de envio de nota fiscal existente.post
Cancela uma nota fiscal através do ID.delete
Atualiza uma nota fiscal existente.put
Retorna uma nota fiscal específica através do ID.get
movements
Cria um novo movimento financeiro de ajuste.post
Remove um movimento financeiro pendente através de um ID.delete
messages
Retorna uma mensagem específica através do ID.get
Envia uma nova mensagem.post
Retorna uma lista de mensagens.get
export_batches
Retorna um lote de exportação específico através do ID.get
Cria um novo lote de exportação.post
Retorna uma lista de lotes de exportação.get
Aprova um lote de exportação específico através do ID.post
import_batches
Retorna um lote de importação específico através do ID.get
Efetua upload de um novo lote de importação.post
Retorna uma lista de lotes de importação.get
issues
Retorna uma lista de pendências.get
Atualiza uma pendência existente através do ID.put
Retorna uma pendência específica através do ID.get
notifications
Cadastra uma nova notificação.post
Retorna uma lista de notificações.get
Remove uma notificação.delete
Atualiza uma notificação.put
Retorna uma notificação através do ID.get
Cria um item para segmentação da notificação.post
Retorna uma lista de items para segmentação da notificação.get
Remove um item da segmentação da notificação.delete
merchants
Retorna uma lista de empresas.get
Retorna a empresa atual.get
/v1/merchants/{id}patch
Retorna uma empresa específica através do ID.get
merchant_users
/v1/merchant_userspost
Retorna uma lista de usuários associados à empresa atual.get
/v1/merchant_users/{id}/reactivatepost
/v1/merchant_users/{id}delete
/v1/merchant_users/{id}put
/v1/merchant_users/{id}get
roles
/v1/rolesget
user
/v1/users/currentget
affiliates
/v1/affiliatespost
Retorna uma lista de participantes do split de pagamentos.get
/v1/affiliates/{id}put
/v1/affiliates/{id}get
/v1/affiliates/{id}/verifyput
partner
Cadastra uma nova conta do parceiropost
Retorna uma lista de contas do parceiro.get
public
Cadastra um novo perfil de pagamentopost

🚧Atenção

200Item atualizado com sucesso.

400Erro de sintaxe JSON no corpo do request.

404Item não encontrado.

422Parâmetros inválidos. Verificar erro na resposta.

🚧
Atenção