discounts

Cria um desconto em uma assinatura existente.

post/v1/discounts

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
  • Auth
    HTTP basic

Request body

bodystring

JSON com atributos do novo desconto.

product_item_idinteger required

ID do item da assinatura que receberá o 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

Response

Desconto criado com sucesso.

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.