item_discount_rate Property

Rate of the discount for each line item (if any).

Syntax

def get_item_discount_rate(item_index: int) -> str: ...
def set_item_discount_rate(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Rate of the discount for each line item (if any).

This property contains the discount percentage applied by the merchant to this line item. This property should be empty (or zero) if the item_unit_cost reflects a discount price or if no line item discount applies.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the line_item_count property.