These helpers operate within an existing quote rate plan context.

addCharge(timelineId, chargeInput)

Signature:

addCharge(
    timelineId: string,
    chargeInput: object | object[] | { charge?: object, charges?: object[] }
): CustomEvent

Returns:

• CustomEvent('updateproducts')

Use this when:

• the target rate plan already exists in the quote.

• the charge payload is valid for that existing rate plan context.

Do not use this when:

• you want to add a brand-new sellable product or rate plan.

• you do not already have a valid timelineId.

For those cases, use addProducts(...) or addProductsInInterval(...).

Example:

this.dispatchEvent(
    zqf.addCharge(timelineId, {
        record: {
            Name: 'Optional Ramp Charge',
            zqu__ProductRatePlanCharge__c: 'a0R...',
            zqu__Action__c: 'Create',
            zqu__Optional__c: true
        }
    })
);

addChargeInInterval(intervalId, timelineId, chargeInput)

Signature:

addChargeInInterval(
    intervalId: number | string | object,
    timelineId: string,
    chargeInput: object | object[] | { charge?: object, charges?: object[] }
): CustomEvent

updateCharge(timelineId, chargeIdOrKey, patch)

Signature:

updateCharge(
    timelineId: string,
    chargeIdOrKey: string,
    patch: object
): CustomEvent

Example:

this.dispatchEvent(
    zqf.updateCharge(timelineId, chargeIdOrKey, {
        zqu__Quantity__c: 7,
        zqu__Discount__c: 15
    })
);

updateChargeInInterval(intervalId, timelineId, chargeIdOrKey, patch)

Signature:

updateChargeInInterval(
    intervalId: number | string | object,
    timelineId: string,
    chargeIdOrKey: string,
    patch: object
): CustomEvent

updateChargeField(timelineId, chargeIdOrKey, fieldName, value)

Signature:

updateChargeField(
    timelineId: string,
    chargeIdOrKey: string,
    fieldName: string,
    value: any
): CustomEvent

updateChargeFieldInInterval(intervalId, timelineId, chargeIdOrKey, fieldName, value)

Signature:

updateChargeFieldInInterval(
    intervalId: number | string | object,
    timelineId: string,
    chargeIdOrKey: string,
    fieldName: string,
    value: any
): CustomEvent

removeCharge(timelineId, chargeIdOrKey)

Signature:

removeCharge(
    timelineId: string,
    chargeIdOrKey: string
): CustomEvent

Use this to remove an existing charge from a quote rate plan in the current context.

removeChargeInInterval(intervalId, timelineId, chargeIdOrKey)

Signature:

removeChargeInInterval(
    intervalId: number | string | object,
    timelineId: string,
    chargeIdOrKey: string
): CustomEvent

Use this to remove an existing charge from a quote rate plan in a specific ramp interval.

Example:

this.dispatchEvent(
    zqf.removeChargeInInterval(1, timelineId, chargeIdOrKey)
);