O objeto discount
poderá ser adicionado a um objeto de assinatura específico (subscription
) para gerar um desconto, podendo aplicar-se a assinatura completa ou apenas a um item desta assinatura. O objeto discount
tem os seguintes atributos:
Atributos | Tipo | Descrição |
---|---|---|
id | string | Código do desconto. Formato: dis_XXXXXXXXXXXXXXXX . |
value | integer | Valor do desconto. |
discount_type | string | Tipo do desconto. Valores possíveis: flat ou percentage . Valor padrão: percentage . |
cycles | integer | Número de vezes que o desconto será aplicado. |
item_id | string | Código do Item que receberá o desconto. Se não informado o desconto será aplicado à oda assinatura. |
status | string | Status do desconto. Valores possíveis: active ou deleted . |
created_at | datetime | Data da criação do desconto (UTC). |