Description
The Pricebook object contains information about a Pricebook.
ℹ️ Note
This object supports custom data via the data attribute.
Attributes
| Attribute | Type | Description |
|---|---|---|
active? |
Boolean | Returns whether this Pricebook is active |
add_to_cart_text |
String | Returns the text to display on the Add to Cart button |
buy_it_now_text |
String | Returns the text to display on the Buy It Now button |
currency |
String | Returns the currency code for this Pricebook |
default_earn_rate |
Number | Returns the default earn rate for this Pricebook |
default_purchase_rate |
Number | Returns the default purchase rate for this Pricebook |
hide_price_text |
String | Returns the text to display when the price is hidden |
id |
String | Returns the unique id for this Pricebook |
name |
String | Returns the name for this Pricebook |
order_quantity_maximum |
Number | Returns the maximum order quantity for this Pricebook |
out_of_stock_text |
String | Returns the text to display when the product is out of stock |
pricebook_entries |
PaginatedList[PricebookEntry] | Returns the PricebookEntries associated with this Pricebook |
standard? |
Boolean | Returns whether this Pricebook is the standard pricebook |
tax_method |
String | Returns the tax method for this Pricebook |
tax_zone |
Zone | Returns the tax zone for this Pricebook |
unavailable_text |
String | Returns the text to display when the product is unavailable |