Usage.md

Bfwd::Usage

Properties

Name	Type	Description	Notes
created	DateTime	{ "description" : "The UTC DateTime when the object was created.", "verbs":["POST","PUT","GET"] }	[optional]
session_id	String	{ "description" : "A (not guaranteed unique) identifier for the session from which this usage was generated.", "verbs":["POST","PUT","GET"] }
subscription_id	String	{ "description" : "ID of the subscription to which this usage instance pertains.", "verbs":["POST","PUT","GET"] }
pricing_component_id	String	{ "description" : "The ID of the pricing component this usage is for.", "verbs":["POST","PUT","GET"] }
pricing_component_name	String	{ "description" : "The name of the pricing component this usage is for.", "verbs":["POST","PUT","GET"] }
uom	String	{ "description" : "The unit-of-measure that this usage is for.", "verbs":["POST","PUT","GET"] }
organization_id	String	{ "description" : "The organization associated with this usage instance.", "verbs":["POST","PUT","GET"] }
usage_period	Integer	{ "description" : "The usage period during which this usage occurred.", "verbs":["POST","PUT","GET"] }	[optional]
usage_duration	Integer	{ "description" : "The amount of time over which usage occurred (in milliseconds?). Relevant for 'temporal' usage only.", "verbs":["POST","PUT","GET"] }	[optional]
usage_type	String	{ "description" : "The type of usage ('Temporal' or 'Itemized').", "verbs":["POST","PUT","GET"] }
usage_value	Integer	{ "description" : "The quantity of product consumed by this usage. Relevant for 'itemized' usage only.", "verbs":["POST","PUT","GET"] }	[optional]
detailed	BOOLEAN	{ "description" : "Is this usage a detailed entry?", "verbs":["POST","PUT","GET"] }	[optional] [default to false]
created_by	String	{ "description" : "Some identifying information about who created this object.", "verbs":["POST","PUT","GET"] }	[optional]
updated_by	String	{ "description" : "Some identifying information about who updated this object.", "verbs":["POST","PUT","GET"] }	[optional]
start	DateTime	{ "description" : "The start date of this usage instance, UTC DateTime", "verbs":["POST","PUT","GET"] }
stop	DateTime	{ "description" : "The end date of this usage instance, UTC DateTime", "verbs":["POST","PUT","GET"] }	[optional]
updated	DateTime	{ "description" : "The UTC DateTime when the object was updated.", "verbs":["POST","PUT","GET"] }	[optional]
occurred_on	DateTime	{ "description" : "The UTC DateTime when the usage occurred.", "verbs":["POST","PUT","GET"] }	[optional]
billing_date	DateTime	{ "description" : "The UTC DateTime when the usage is to be billed.", "verbs":["POST","PUT","GET"] }	[optional]