Upgrade

  • Upgrade category. Used to distinguish between regular adders and discounts.

    values
    addersdiscountscustom_discountcustom_upgrade
  • The resolved single equipment group for this upgrade, computed based on equipmentGroups order and project equipment presence. Read-only, computed by the API.

    values
    solarbatterywindowdoorhvacinsulationwater-heatermpuroof
  • Equipment groups this upgrade belongs to. Used for categorizing upgrades by vertical in price breakdowns. Order matters - first matching group takes priority when resolving effectiveEquipmentGroup.

    values
    solarbatterywindowdoorhvacinsulationwater-heatermpuroof
  • External system identifier

  • GoodLeap upgrade name for financing integration

  • Whether to hide this upgrade from the proposal

  • Unique identifier for the upgrade

  • Whether this upgrade is selected

  • Labor cost component

  • Maximum total amount cap (used for percent-based upgrades/discounts)

  • Display name of the upgrade

  • Formatted price string

  • Price per unit

  • Quantity/amount

  • Tooltip text for the upgrade

  • Computed total price for this upgrade (included in API responses)

  • Upgrade pricing calculation type

    values
    fixedsystem_sizenumber_of_panelsmanual_entrybattery_capacitycustom_discountcustom_upgradepercentlinearsash_countlite_count
  • Unit of measurement for pricing

    values
    quantitydollar_per_wattdollar_per_footdollar_per_paneldollar_per_roof_planedollarquantity_per_wattdollar_per_kwhdollar_per_sq_ftsashlitedollar_per_ui