priceScaleFactor added to the Portion object in the menus API

The Portion object now includes a new priceScaleFactor value. This value contains a multiplier number that adjusts the cost of modifiers applied to that portion. For example, consider a pepperoni modifier that normally costs $6 when applied to a whole pizza. If the priceScaleFactor for the 1st Half portion is set to 0.5, then the cost of the pepperoni modifier when applied to the 1st Half portion is $3.

The priceScaleFactor value can be any positive number between 0 and 100, with a maximum of 2 decimal places. The priceScaleFactor value is null if a price multiplier has not been configured for the portion.

When priceScaleFactor is not null, your integration should calculate the price of a modifier as if it applies to the whole menu item and then multiply that price by the priceScaleFactor to arrive at a price for the portion. For examples of how modifiers are priced when they are applied to portions, both with and without a priceScaleFactor, see the Portions section of the Toast Platform Guide.

The Price Multiplier setting that supports priceScaleFactor value is not available in Toast Web until 2025-12-03, so currently the priceScaleFactor value is always null. After 2025-12-03, this setting will be in limited release and the priceScaleFactor value may contain a number.

Like all changes to the menus API, the priceScaleFactor become available in the menu JSON after a restaurant has made a menus-related change and published the new menu, which initiates regeneration of the restaurant's menus data. For more information, see Menus API returns published data only.

This change applies to both V2 and V3 of the menus API.

Note

For information on the differences between V2 and V3 of the menus API, see Comparing menus API V2 and V3.