Prices

The price object represents the actual rate that will be charged for a specific contract. From a modeling perspective, it can be thought of as the merge between list and contract prices. Prices are not stored by default and can be found within the bframe schema. They are used for pricing purposes.

Diagram

Table description

Column name	Data type	Description
list_price_uid	INTEGER	An identifier referencing a unique list price row. Refers to list_prices.id.
contract_price_uid	INTEGER	An identifier referencing a unique contract price row. Refers to contract_prices.id.
price	VARCHAR	A string that determines the rate of this object.
invoice_delivery	VARCHAR	A string that represents if the invoice will be delivered at the beginning of the month, “ADVANCED”, or at the end of the month, “ARREARS”
invoice_schedule	INTEGER	An integer for the number of months in a billing or service period.
started_at	TIMESTAMP	A timestamp that represents the beginning of the objects billing period. This timestamp is inclusive.
ended_at	TIMESTAMP	A timestamp that represents the completion of the objects billing period. This timestamp is exclusive.
effective_at	TIMESTAMP	A timestamp that represents the beginning of the objects active period. This timestamp is inclusive.
ineffective_at	TIMESTAMP	A timestamp that represents the completion of the objects active period. This timestamp is exclusive.
fixed_quantity	DECIMAL(18,3)	A decimal that defines a static count of a product being sold.
product_type	VARCHAR	A string that refers to the type of product ("FIXED", "EVENT", etc).
product_uid	INTEGER	An identifier referencing a unique product row. Refers to product.id.
pricebook_uid	INTEGER	An identifier referencing a unique pricebook row. Refers to pricebooks.id.
contract_uid	BIGINT	An identifier referencing a unique contract row. Refers to contracts.id.
prorate	BOOLEAN	A boolean that determines whether or not proration is applied to the object.
pricing_metadata	JSON	A JSON object that contains custom logic for pricing (user defined).