CouponRule.md

Bfwd::CouponRule

Properties

Name	Type	Description	Notes
parent_rule_id	String	{ "description" : "ID of the parent of this coupon-rule.", "verbs":["POST","PUT","GET"] }
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-rule.", "verbs":["POST","PUT","GET"] }	[optional]
organization_id	String	{ "description" : "ID of the organization associated with the coupon-rule.", "verbs":["POST","PUT","GET"] }
coupon_definition_id	String	{ "description" : "ID of the coupon-definition associated with the coupon-rule.", "verbs":["POST","PUT","GET"] }
subject	String	{ "description" : "The subject of the coupon-rule. The coupon-rule can operate on either the user or subscription that the coupon-instance is associated with.", "verbs":["POST","PUT","GET"] }
polarity	String	{ "description" : "Specifies whether the rule's result will affect the application of the coupon-instance positively or negatively.", "verbs":["POST","PUT","GET"] }
verb	String	{ "description" : "The verb of the coupon-rule. coupon-rules can check whether the user or subscription has a certain property.", "verbs":["POST","PUT","GET"] }
preposition	String	{ "description" : "This is the comparison operator of the coupon-rule's parameter and the subject's object.", "verbs":["POST","PUT","GET"] }
parameter	String	{ "description" : "The parameter for the coupon-rule. This specifies the ID or the quantity for the object of the subject.", "verbs":["POST","PUT","GET"] }
object	String	{ "description" : "The property of the subject of the coupon-rule. e.g. When the subject is 'subscription' and the object is 'product-ID', the coupon-rule will observe the product-ID for that subscription.", "verbs":["POST","PUT","GET"] }
rule_validation_strategy	String	{ "description" : "The rule-validation-strategy object associated with the coupon-rule.", "verbs":["POST","PUT","GET"] }
specifier	String	{ "description" : "When the subject is subscription, the specifier is used to define which unit of measure the coupon rule will operate on. When the subject is user, the specifier defines which property of the user's account it will operate on.", "verbs":["POST","PUT","GET"] }
deleted	BOOLEAN	{ "description" : "Has the coupon-modifier been deleted.", "verbs":["POST","PUT","GET"] }	[default to false]
child_rules	Array<CouponRule>	{ &quot;description&quot; : &quot;The collection of child coupon-rules associated with the coupon-rule.&quot;, &quot;verbs&quot;:[&quot;POST&quot;,&quot;PUT&quot;,&quot;GET&quot;] }