CouponBook.md

Bfwd::CouponBook

Properties

Name	Type	Description	Notes
book_code	String	{ "description" : "The book code for the coupon-book. This is used to create coupon-instances which are associated with subscriptions.", "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-book.", "verbs":["POST","PUT","GET"] }
crm_id	String	{ "description" : "CRM ID of the product-rate-plan.", "verbs":["POST","PUT","GET"] }
organization_id	String	{ "description" : "Organization associated with the the coupon-book.", "verbs":["POST","PUT","GET"] }
coupon_book_definition_id	String	{ "description" : "ID of the coupon-book-definition associated with the coupon-book.", "verbs":["POST","PUT","GET"] }
name	String	{ "description" : "The human readable name of the coupon-book.", "verbs":["POST","PUT","GET"] }
cost	Float	{ "description" : "The cost of the coupon-book. Can be used to keep track of coupon-book sales.", "verbs":["POST","PUT","GET"] }
remaining_coupons	Integer	{ "description" : "The number of available coupon-instances left in the coupon-book.", "verbs":["POST","PUT","GET"] }
max_remaining_coupons	Integer	{ "description" : "The original number of available coupon-instances that the coupon-book can hold.", "verbs":["POST","PUT","GET"] }
maximum_coupon_uses	Integer	{ "description" : "The maximum number of uses each coupon-instance created from this coupon-book can have.", "verbs":["POST","PUT","GET"] }
deleted	BOOLEAN	{ "description" : "Has the coupon book been deleted?", "verbs":["POST","PUT","GET"] }	[default to false]