VIvindi
discounts

Retorna uma desconto específico através do ID.

Um desconto pode ser aplicado à um item específico de uma assinatura (product_item) e possui duração configurável (cycles). Utilize este método para obter detalhes de um desconto específico.

Duração

A duração de um desconto pode ser definida através do atributo cycles que representa o número de ciclos de recorrência onde o desconto será aplicado. É possível, por exemplo, configurar um desconto apenas para a próxima fatura, ou então conceder um desconto permanente. Neste último caso, o atributo cycles deverá permanecer nulo.

Tipo

Cada desconto possui um tipo de cálculo diferente que deve ser informado no atributo discount_type. Os seguintes tipos de desconto estão disponíveis:

TipoDescrição
percentagePorcentagem: Desconto baseado na porcentagem informada. Utilize um valor númerico entre 0.01 e 100.
amountValor fixo: Desconto no valor exato informado. Mínimo: 0.01.
quantityQuantidade: Apenas para produtos com precificação por quantidade fixa (sem faixas). Informe um valor inteiro maior ou igual a 1.

Cálculo

Todos os descontos ativos serão aplicados no momento da geração da fatura e serão calculados a partir do valor original do item.

Caso o total de descontos seja superior ao valor original, o preço final do produto permanecerá R$ 0,00.

Desconto sobre desconto

Se um item possuir mais de um desconto ativo, todos eles serão calculados a partir do valor original, conforme mencionado acima. Como exemplo, considere um item que custava originalmente R$ 100,00 e recebeu dois descontos: R$ 10,00 e 50%:

Valor original: R$ 100,00
Desconto 1: R$ 10,00
Desconto 2: 50% de R$ 100,00 = R$ 50,00
--
Valor final do produto: R$ 100,00 - R$ 60,00 = R$ 40,00
get/v1/discounts/{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/discounts/{id}
  • Auth
    HTTP basic

Path parameters

idinteger required

ID do desconto que deverá ser retornado.

Response

Ok. Desconto encontrado.

idinteger required

ID do desconto

discount_type'percentage' | 'amount' | 'quantity' required

Tipo do desconto

percentagenumber

Valor numérico para porcentagem de 0.01 até 100

amountnumber

Valor para desconto fixo

quantityinteger

Número para desconto por quantidade

cyclesinteger

Número de ciclos de recorrência onde o desconto será aplicado a partir do momento de sua criação. Nulo significa desconto por tempo indefinido

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

Status do desconto

created_atstring required

Data e hora do cadastro do desconto

updated_atstring required

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

Changes

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