v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
periods

Retorna uma lista de períodos.

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

Atributos para busca

<code>id</code>, <code>billing_at</code>, <code>subscription_id</code>, <code>start_at</code>, <code>end_at</code>, <code>cycle</code>, <code>duration</code>, <code>created_at</code> e <code>updated_at</code>.

get/v1/periods

Query parameters

pageinteger

Page of results to fetch.

per_pageinteger

Number of results to return per page.

querystring

Filtro para busca

sort_by'id' | 'billing_at' | 'subscription_id' | 'start_at' | 'end_at' | 'cycle' | 'duration' | 'created_at' | 'updated_at'

Atributo opcional para ordenação

sort_order'asc' | 'desc'

Sentido opcional para ordenação

Response

Consulta realizada com sucesso.

idinteger required

ID do período

billing_atstring

Data para geração automática da cobrança do período

cycleinteger required

Ciclo do período

start_atstring required

Data e hora do início do período

end_atstring required

Data e hora do término do período

durationinteger required

Duração do período em número de segundos

created_atstring required

Data e hora da geração do período

updated_atstring required

Data e hora da última atualização do período