Incremento

O objeto increment poderá ser adicionado a um objeto de assinatura específico (subscription) para gerar um incremento, podendo aplicar-se a assinatura completa ou apenas a um item desta assinatura. O objeto increment tem os seguintes atributos:

AtributosTipoDescrição
idstring
  • Código do incremento_. Formato: inc_XXXXXXXXXXXXXXXX.
valueinteger
  • Valor do incremento_.
increment_typestring
  • Tipo do incremento_.
    Valores possíveis: flat ou percentage. Valor padrão: percentage.
cyclesinteger
  • Número de vezes que o incremento será aplicado_.
item_idstring
  • Código do Item que receberá o incremento_. Se não informado o incremento será aplicado à toda assinatura.
statusstring
  • Status do incremento_. Valores possíveis: active ou deleted.
created_atdatetime
  • Data da criação do incremento (UTC)_.