Sign in

v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
plans

Retorna uma lista de planos.

Utilize este método para listar os planos associados à sua conta na Vindi. Leia a documentação sobre paginação e filtros de busca.

Atributos para busca

<code>id</code>, <code>installments</code>, <code>name</code>, <code>interval_count</code>, <code>interval</code>, <code>billing_cycles</code>, <code>code</code>, <code>status</code>, <code>billing_trigger_day</code>, <code>billing_trigger_type</code>, <code>created_at</code> e <code>updated_at</code>.

get/v1/plans

Query parameters

pageinteger

Page of results to fetch.

per_pageinteger

Number of results to return per page.

querystring

Filtro para busca

sort_by'id' | 'installments' | 'name' | 'interval_count' | 'interval' | 'billing_cycles' | 'code' | 'status' | 'billing_trigger_day' | 'billing_trigger_type' | 'created_at' | 'updated_at'

Atributo opcional para ordenação

sort_order'asc' | 'desc'

Direção opcional para ordenação

Response

Consulta realizada com sucesso.

idinteger required

ID do plano

namestring required

Nome do plano

interval'days' | 'months' required

Duração do intervalo

interval_countinteger required

Número de intervalos dentro de um período

billing_trigger_type'beginning_of_period' | 'end_of_period' | 'day_of_month' required

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

billing_trigger_dayinteger required

Dia para geração da cobrança

billing_cyclesinteger

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

codestring

Código externo para referência via API

descriptionstring

Descrição interna do plano

status'active' | 'inactive' | 'deleted' required

Status do plano

installmentsinteger required

Número de parcelas

invoice_splitstring required

Nota fiscal fracionada

interval_namestring required

Nome do intervalo do plano gerado automaticamente a partir dos parâmetros de duração

created_atstring required

Data e hora do cadastro do plano

updated_atstring required

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

metadataobject

Metadados do plano