Sign in

v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
subscriptions

Retorna uma lista de assinaturas.

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

Atributos para busca

<code>status</code>, <code>id</code>, <code>code</code>, <code>installments</code>, <code>customer_id</code>, <code>interval</code>, <code>interval_count</code>, <code>billing_trigger_day</code>, <code>billing_trigger_type</code>, <code>billing_cycles</code>, <code>plan_id</code>, <code>payment_method_id</code>, <code>start_at</code>, <code>cancel_at</code>, <code>overdue_since</code>, <code>created_at</code>, <code>updated_at</code> e <code>end_at</code>.

Inadimplência

Além dos filtros acima, a busca por assinaturas adimplentes ou inadimplentes pode ser realizada através do atributo overdue_since no parâmetro query. Exemplos:

  • Assinaturas adimplentes: overdue_since = null
  • Assinaturas inadimplentes: overdue_since != null
  • Assinaturas inadimplentes há mais de n dias: overdue_since < 2016-03-15

Itens da assinatura

Uma assinatura é composta de vários itens representados no array product_items. Este endpoint lista apenas os 25 primeiros itens de cada assinatura. Caso queira listar mais itens de uma assinatura, utilize o método da API GET /subscriptions/{id}/product_items.

get/v1/subscriptions

Query parameters

pageinteger

Page of results to fetch.

per_pageinteger

Number of results to return per page.

querystring

Filtro para busca

sort_by'id' | 'code' | 'installments' | 'customer_id' | 'interval' | 'interval_count' | 'billing_trigger_day' | 'billing_trigger_type' | 'billing_cycles' | 'plan_id' | 'payment_method_id' | 'start_at' | 'cancel_at' | 'overdue_since' | 'created_at' | 'updated_at' | 'end_at'

Atributo opcional para ordenação

sort_order'asc' | 'desc'

Sentido opcional para ordenação

Response

Consulta realizada com sucesso.

idinteger required

ID da assinatura

status'active' | 'canceled' | 'future' | 'expired' required

Status da assinatura

start_atstring required

Data do início da assinatura no formato ISO 8601

end_atstring

Data do término da assinatura no formato ISO 8601

next_billing_atstring

Data da próxima cobrança da assinatura

overdue_sincestring

Data do início da inadimplência

codestring

Código externo para referência via API

cancel_atstring

Data do cancelamento da assinatura

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 da assinatura. Nulo significa duração indefinida

installmentsinteger required

Número de parcelas

created_atstring required

Data e hora do cadastro da assinatura

updated_atstring required

Data e hora da última atualização da assinatura

metadataobject

Metadados da assinatura

invoice_splitstring

Nota fiscal fracionada. Indica se uma nota fiscal será emitida de acordo com a periodicidade do plano.