CouponInstance.md

Bfwd::CouponInstance

Properties

Name	Type	Description	Notes
target_id	String	{ "description" : "Target ID of the coupon-instance. If the target is subscription, this is the subscription's ID. If the target is account, this is the account's ID.", "verbs":["POST","PUT","GET"] }	[optional]
coupon_code	String	{ "description" : "Code for the coupon. This code can be used to apply coupon-instances to subscriptions or accounts.", "verbs":["POST","PUT","GET"] }	[optional]
date_initialised	DateTime	{ "description" : "The UTC DateTime the coupon was initialised.", "verbs":["POST","PUT","GET"] }
valid_till	DateTime	{ "description" : "The UTC DateTime the coupon-instance is valid until.", "verbs":["POST","PUT","GET"] }	[optional]
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-instance.", "verbs":["POST","PUT","GET"] }	[optional]
crm_id	String	{ "description" : "CRM ID of the product-rate-plan.", "verbs":["POST","PUT","GET"] }
organization_id	String	{ "description" : "Organization associated with the", "verbs":["POST","PUT","GET"] }
book_id	String	{ "description" : "ID of the coupon-book associated with the coupon-instance.", "verbs":["POST","PUT","GET"] }
coupon_definition_id	String	{ "description" : "ID of the coupon-definition associated with the coupon-instance.", "verbs":["POST","PUT","GET"] }
target	String	{ "description" : "Ttype of the target for the coupon-instance. Used in combination with the targetID.", "verbs":["POST","PUT","GET"] }
periods_valid_for	Integer	{ "description" : "Number of subscription periods the coupon is valid for. Unused.", "verbs":["POST","PUT","GET"] }
total_periods	Integer	{ "description" : "Unused.", "verbs":["POST","PUT","GET"] }
remaining_uses	Integer	{ "description" : "The number of remaining uses the coupon-instance has left.", "verbs":["POST","PUT","GET"] }
instance_discount_value	Float	{ "description" : "(Optional) The value to be used for dynamic price calculation, if the coupon definition has an 'instance' or 'instance_percent' coupon modifier. If it is not set, the effect amount of the coupon modifier will be used.", "verbs":["POST","PUT","GET"] }	[optional]
max_remaining_uses	Integer	{ "description" : "The number of remaining uses the coupon-instance had upon initialisation.", "verbs":["POST","PUT","GET"] }
coupon_instance_existing_values	Array<CouponInstanceExistingValue>	{ &quot;description&quot; : &quot;The collection of coupon-instance-existing-value objects associated with the coupon-instance.&quot;, &quot;verbs&quot;:[&quot;POST&quot;,&quot;PUT&quot;,&quot;GET&quot;] }