Price spans¶

The price span object is used for staging purposes to create rated documents. From a modeling perspective, it represents a join between contracts, prices and dates. the actual rate that will be charged for a specific contract. Price spans are mostly used for staging and debugging purposes so they not stored and can be found within the bframe schema.

Diagrams¶

Table description¶

Column name	Data type	Description
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.
proration_start	TIMESTAMP	A timestamp that represents the start of the proration range. This timestamp is inclusive.
proration_end	TIMESTAMP	A timestamp that represents the end of the proration range. This timestamp is exclusive.
price	VARCHAR	A string that determines the rate of this object.
pricing_metadata	JSON	A JSON object that contains custom logic for pricing (user defined).
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).
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”
prorate	BOOLEAN	A boolean that determines whether or not proration is applied to the object.
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`.
product_uid	INTEGER	An identifier referencing a unique product row. Refers to `product.id`.
pricebook_id	VARCHAR	An identifier referencing a pricebook. Refers to `pricebooks.durable_id`.
contract_id	VARCHAR	An identifier referencing a contract. Refers to `contracts.durable_id`.
contract_uid	BIGINT	An identifier referencing a unique contract row. Refers to `contracts.id`.
customer_id	VARCHAR	An identifier referencing a customer. Refers to `customers.durable_id`.