Sobre o Vindi DevelopersCases de SucessoStatus Page
Referência da API

Atualiza um plano existente.

put
https://app.vindi.com.br/api/v1/plans/

Verifique documentação dos atributos no método GET plans/{id}.

Atualizando produtos relacionados

A lista de produtos relacionados à um plano é representado pelo array plan_items.

  • Para atualizar um objeto existente no array plan_items, simplesmente indique seu ID e os novos atributos.
  • Para criar um novo objeto, informe apenas os atributos sem o ID.
  • Para remover um objeto existente, inclua o atributo "_destroy": "1", sem esquecer de informar o ID.

Além disso é possível omitir o parâmetro plan_items na requisição para não atualizar os produtos relacionados.

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

ID do plano que deverá ser atualizado.

Body Params

Atualiza um plano existente.

string

JSON com os novos atributos do plano.

string
required

Nome do plano

string
enum
required

Duração do intervalo

Allowed:
int32
required

Número de intervalos dentro de um período

string
enum
required

Referência para data de geração da cobrança

Allowed:
int32
required

Dia para geração da cobrança

int32

Número máximo de períodos em uma assinatura. Nulo significa duração indefinida

string

Código externo para referência via API

string

Descrição interna do plano

int32

Número de parcelas. Se não for informado, o valor '1' será utilizado

string

Nota fiscal fracionada

string
enum

Status do plano

Allowed:
plan_items
array of objects

Lista de itens incluídos no plano

plan_items
string
enum

Metadados do plano

Allowed:
Responses

Updated about 2 months ago

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

Updated about 2 months ago