VIvindi
subscriptions

Atualiza uma assinatura existente.

Utilize este método para alterar os atributos de uma assinatura existente.

Reagendamento da data de cobrança

A data de cobrança da assinatura pode ser atualizada através dos parâmetros billing_trigger_type e billing_trigger_day.

Após a atualização, a plataforma irá retornar a próxima data de cobrança calculada no atributo next_billing_at. Se esta data for igual ou anterior ao dia corrente, você poderá gerar uma fatura manualmente usando o método POST /periods/{id}/bill. A plataforma não irá emitir faturas retroativas automaticamente.

Por motivos de retrocompatibilidade, a atualização da data de cobrança diretamente através do parâmetro next_billing_at ainda é possível, porém não recomendável.

Desvincular perfil de pagamento

Para desvincular um perfil de pagamento de uma assinatura sem vincular outro perfil, envie:

{
  "payment_profile": {
    "id": null
  }
}

Itens da assinatura

Para atualizar os itens da assinatura, utilize o serviço product_items.

put/v1/subscriptions/{id}

Request

  • Base URL
    //app.vindi.com.br/api (relative, and the document’s source URL is not known)
  • URL
    //app.vindi.com.br/api/v1/subscriptions/{id}
  • Auth
    HTTP basic

Path parameters

idinteger required

ID da assinatura que deverá ser atualizada.

Request body

bodystring

JSON com os novos atributos da assinatura.

codestring

Código externo para referência via API

payment_method_codestring required

Código do método de pagamento

installmentsinteger

Parcelamento da cobrança. Deve ser informado apenas se você desejar sobrescrever a configuração herdada do plano

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

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

billing_trigger_dayinteger

Dia para geração da cobrança.

metadata'array'

Metadados da assinatura

invoice_splitstring

Nota fiscal fracionada. Indica se uma nota fiscal será emitida de acordo com a periodicidade do plano (true). Deve ser informado apenas se você desejar sobrescrever a configuração herdada do plano

Response

Assinatura atualizada 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.

Changes

No recorded changes to this operation across all 1 revision of this API.