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:
Atributos | Tipo | Descrição |
---|---|---|
id | string | Código do incremento. Formato: inc_XXXXXXXXXXXXXXXX . |
value | integer | Valor do incremento. |
increment_type | string | Tipo do incremento. Valores possíveis: flat ou percentage . Valor padrão: percentage . |
cycles | integer | Número de vezes que o incremento será aplicado. |
item_id | string | Código do Item que receberá o incremento. Se não informado o incremento será aplicado à toda assinatura. |
status | string | Status do incremento. Valores possíveis: active ou deleted . |
created_at | datetime | Data da criação do incremento. |