Configure price and quantity ramps
Explore the system and administrative configuration required to support Price and Quantity Ramps, including Sold Product and Primitives behavior.
Pre requisites
- The product offering must use Recurring pricing and have Enable Ramps selected.
- Multi‑instance products cannot be enabled for ramps.
- Ramps must be supported for the target entity (Quote, Order, Contract, or Sold Product).
- For Sold Products (headerless entities), ramp records must be explicitly associated during instance creation.
- The Primitives framework with enhanced
CreateInstancesupport must be available.
Hinweis:
Lead to Cash Core plugin is required for the setup.
Enable ramps for products
Before ramps can be used, they must be enabled at the product level.
- Ramps can be enabled only for products that use recurring pricing.By default, ramp support is disabled.
- When ramps are enabled, the product is treated as configurable so ramp segments can be created and managed.
- Multi‑instance products and ramp‑enabled products are mutually exclusive.
Configure ramp support for Sold Products
Sold Products are headerless entities, which means ramps cannot be automatically inferred during instance creation. To support ramps for Sold Products, the system must be configured to:
- Handle multiple root‑level entity definitions
- Explicitly associate ramp records with Sold Products during instance creation
- Generate a single JSON structure that includes both Sold Product hierarchy and ramp data.
Configure CreateInstance parameters for Ramps
Ramp support is enabled through configuration of the createInstance API using additionalParams.
Configure fetchRecordSysIds
Use
fetchRecordSysIds to explicitly associate ramp records with entities.- No‑header scenarios (Sold Product)
- Mandatory to fetch ramp data.
- Without ramp sys_ids, ramp data is not returned.
- Header‑based scenarios (Quote, Order)
- Optional.
- Used to selectively fetch specific ramps linked to the header.
- If not provided, all ramps linked to the header are fetched.
Configure multiSelectMerge(no‑header only)
Use multiSelectMerge when multiple Sold Products share the same ramp.
- Merges all ramps together and all Sold Products together into a single consolidated structure.
- Supported only for no‑header scenarios.
- Cannot be enabled together with multiSelect.
Ramp Modifications
- Modifications to configuration apply to all active and future segments.
- Quantity changes apply to individual segments.
- Expired segments cannot be modified.
- Mid-segment changes split the segment into two, with the new configuration applied from the effective date onward.