FixedTerm.md

Bfwd::FixedTerm

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	id	[optional]
subscription_id	String	{ "description" : "subscriptionID", "verbs":["POST","PUT","GET"] }
organization_id	String	{ "description" : "The ID of the organization associated with the amendment.", "verbs":["POST","PUT","GET"] }
fixed_term_definition_id	String	{ "description" : "fixedTermDefinitionID", "verbs":["POST","PUT","GET"] }
fixed_term_definition	MutableBillingEntity
expiry_behaviour	String	fixedTermExpiryBehaviour
state	String	state
product_rate_plan_as_of_time	DateTime	productRatePlanAsOfTime
compound_uplift	Float	{ "description" : "compoundUplift", "verbs":["POST","PUT","GET"] }The proportional INCREASE in price applied every time the fixed terms recur. e.g. 0.03 is a 3% increase. -0.5 is a 50% decrease. 3 is a 300% increase
start_time	DateTime	start_time
expiry_time	DateTime	expiry_time
periods	Integer	{ "description" : "The number of billing periods that this fixed term lasts for.", "verbs":["POST","PUT","GET"] }
fixed_term_number	Integer	{ "description" : "The number of sequential fixed terms previous to this one for the subscription (i.e. zero indexed 'fixedTermCount').", "verbs":["POST","PUT","GET"] }
deleted	BOOLEAN	{ "description" : "Is the fixedTerm deleted.", "verbs":["POST","PUT","GET"] }	[default to false]