Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Name

Type

Description

discount_optionString

The type of discount which will be applied, which can be one of the following

  • AMOUNT
  • AMOUNT_PER_PERIOD
  • PERCENTAGE
  • PERCENTAGE_PER_PERIOD
  • FREE_USAGE
Tip

Available from CRM.COM R15.0.0

discount_amountNumber

The discount amount that will be applied,  if the additive discount definition is set up to provide a range of discount based on amount.

discount_percentageNumberThe discount percentage that will be applied,  if the additive discount definition is set up to provide a range of discount based on percentage
discount_free_usageNumber

The free usage discount that will be applied,  if the additive discount definition is set up to provide a range of discount based on usage.

 The UOM depends on the UOM of the usage service being discounted

Tip

Available from CRM.COM R15.0.0

forFor Object

The discounted period every time the discount is given when the Discount Option is Percentage per Period or Amount per Period. The possible options are the following:

  • X_UOT
  • 1_Billing_Period
Tip

Available from CRM.COM R15.0.0

renewRenew Object

How often the discount is renewed (provided again) when the Discount Option is Percentage per Period or Amount per Period which can have one of the following options:

    • Never
    • Every_x_UOT
    • Every_Billing_Cycle
Tip

Available from CRM.COM R15.0.0

from_dateDateThe date that the additive discount will be applicable from
to_dateDateThe date that the additive discount will be applicable to
currencyCurrency Object

The currency in which the discount amount is returned

additive_discount_definitionAdditive Discount Definition ObjectThe additive discount definition that will be applied
productProduct ObjectThe product that will be discounted by the specified additive discount definition

...