CouponModifierBase.md

Bfwd::CouponModifierBase

Properties

Name	Type	Description	Notes
created	DateTime	{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }	[optional]
changed_by	String	{ "description" : "ID of the user who last updated the entity.", "verbs":[] }	[optional]
updated	DateTime	{ "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }	[optional]
id	String	{ "description" : "ID of the coupon-modifier.", "verbs":["POST","PUT","GET"] }	[optional]
organization_id	String	{ "description" : "ID of the organization associated with the coupon-modifier.", "verbs":["POST","PUT","GET"] }
coupon_definition_id	String	{ "description" : "The unique ID of the coupon-definition associated with the coupon-modifier.", "verbs":["POST","PUT","GET"] }	[optional]
effect_amount	Float	{ "description" : "The effect amount for the coupon-modifier. This is affected by the operand field.", "verbs":["POST","PUT","GET"] }
operand	String	{ "description" : "The operand field affects the effect amount of the coupon-modifier. If the operand is fixed, it is an exact amount of the currency defined by the coupon-definition. If the operand is percent, this means the coupon will be affecting a percentage of the unaltered cost. E.g. a 25% modifier will apply a 25% discount on a subscription or a pricing-component.", "verbs":["POST","PUT","GET"] }
effect	String	{ "description" : "The effect of the coupon-modifier. The coupon-modifier can affect first, last, and cheapest value of a specific unit-of-measure-id for a subscription. The coupon-modifier can also affect all of the values for a unit-of-measure-id, or can affect all of the subscription cost.", "verbs":["POST","PUT","GET"] }
effect_additional	BOOLEAN	{ "description" : "Specifies whether the coupon-modifier will be affecting only additional units. If this field is set, the coupon-instance-existing-values for the coupon-instance are observed, and any units of the unit-of-measure-id defined by the modifier below the coupon-instance-existing-values for that unit-of-measure-id will be ignored.", "verbs":["POST","PUT","GET"] }	[default to false]
specifier_amount	Integer	{ "description" : "The number of units that will be affected by the coupon-modifier, if the domain is set to uom", "verbs":["POST","PUT","GET"] }
domain	String	{ "description" : "The domain of the coupon-modifier", "verbs":["POST","PUT","GET"] }
specifier	String	{ "description" : "The specifier is domain-specific. If the domain is uom, this field is used to limit the coupon-modifier to a specific unit-of-measure-id.", "verbs":["POST","PUT","GET"] }	[optional]
precedence	Integer	{ "description" : "The precedence of the coupon-modifier. This is used to order application of coupon-modifiers. Higher precedence means the coupon-modifier will be applied before others.", "verbs":["POST","PUT","GET"] }
deleted	BOOLEAN	{ "description" : "Has the coupon-modifier been deleted.", "verbs":["POST","PUT","GET"] }	[default to false]