Pricebooks Object

The pricebooks object is set under a catalog containing a pricing scheme based on sales tracking codes. You may set a default pricing layout as well as attach specific sales tracking codes to specific pricing layouts so they can be easily attached onto a subscription.

🚧
Elevated Permissions Required
This call will result in a 404 HTTP error unless its use has been enabled for your Fusebill account. Contact support if you would like this enabled for your organization.

Property	Type	Description
`name`	String	This is the name of the pricebook. [Max Length: 500 characters]
`description`	String	This is the description of the pricebook.
`code`	String	The unique identification code specific to the pricebook[Max Length: 500 characters]
`deletable`	Boolean	Indicates whether the pricebook is in use to determine whether it is deletable.
`defaultPrice`	Object	The default pricing settings set to the pricebook with no sales tracking code attachment.
`pricebookEntries`	List of objects	Once attached to a sales tracking code it will be integrated into the system as a Pricebook Entry (see fields below)
isUsingDateBasedPricebook	Boolean	Defines whether this is a date based (true) or Sales tracking code based (null/false) pricebook. Date based can be used to schedule price changes into the future.

Default Price (pricingModel)

Property	Type	Description
`pricingModelType`	Enum: {Standard, Tiered, Stairstep, Volume, Formula, Pricebook}	Dictates how the price is calculated using the quantity. This is for the purchase object created when this product is purchased outside a plan
`pricingFormulaType`	Enum: {OpeningBalance, InvoiceAgingBalances}	The pricing formula type that is either OpeningBalance or InvoiceAgingBalances, can also be set to null.
`quantityRanges`	Object (defined below)	A collection of ranges that control the price of the purchase based on its `quantity` field.

Quantity Ranges Fields

Property	Type	Description
`min`	Decimal	The lower bound for the value of `quantity`. If the purchase of this product has a `quantity` in this quantity range, the price in `prices` matching the customer's currency is used.
`max`	Decimal	The upper bound for the value of `quantity`.If the purchase of this product has a `quantity` in this quantity range, the price in `prices` matching the customer's currency is used. NULL means infinity
`prices`	List of Objects. Defined below.	A list of prices based on each configured currency.

Prices fields

Property	Type	Description
`amount`	Decimal	The price in units of the `currency`.
`currency`	String	The 3 character ISO code of the currency this price is measured in.

Pricebook Entries

Property	Type	Description
`priority`	Integer	The priority in which the pricing model gets set due to how it is attached onto a subscription. Will iterate through priority list and will set it to first match ignoring everything below.
`salesTrackingCode1Id`	Integer	The Id associated to this sales tracking code generated by Stax Bill.
`salesTrackingCode1Name`	String	The name associated to this sales tracking code.
`salesTrackingCode1Code`	String	The unique code identifier associated to this sales tracking code.
`salesTrackingCode2Id`	Integer	The Id associated to this sales tracking code generated by Stax Bill.
`salesTrackingCode2Name`	String	The name associated to this sales tracking code.
`salesTrackingCode2Code`	String	The unique code identifier associated to this sales tracking code.
`salesTrackingCode3Id`	Integer	The Id associated to this sales tracking code generated by Stax Bill.
`salesTrackingCode3Name`	String	The name associated to this sales tracking code.
`salesTrackingCode3Code`	String	The unique code identifier associated to this sales tracking code.
`salesTrackingCode4Id`	Integer	The Id associated to this sales tracking code generated by Stax Bill.
`salesTrackingCode4Name`	String	The name associated to this sales tracking code.
`salesTrackingCode4Code`	String	The unique code identifier associated to this sales tracking code.
`salesTrackingCode5Id`	Integer	The Id associated to this sales tracking code generated by Stax Bill.
`salesTrackingCode5Name`	String	The name associated to this sales tracking code.
`salesTrackingCode5Code`	String	The unique code identifier associated to this sales tracking code.
`pricingModel`	Object (see above)	The default pricing settings set to the pricebook with no sales tracking code attachment.
startingDate	String (Date)	When the pricebook's isUsingDateBasedPricebook is true (indicating that this is a date based pricebook instead of a sales tracking code based one) then this startingDate on an entry is the first day that this different price will be used (until the next entry's starting date). Or back to the default price if not in use.