getQuote()

Signature:

getQuote(): object | null

Returns the current quote record.

Example:

const quote = zqf.getQuote();
const quoteName = quote?.Name;

getQuoteField(fieldName)

Signature:

getQuoteField(fieldName: string): any

Example:

const term = zqf.getQuoteField('zqu__InitialTerm__c');

getSubscription()

Signature:

getSubscription(): object | null

Returns the active subscription object from quoteState.

getProductTimelines(filter?)

Signature:

getProductTimelines(filter?: {
    timelineIds?: string[],
    includeVoided?: boolean
}): object[]

Example:

const timelines = zqf.getProductTimelines();

getTimeline(timelineId)

Signature:

getTimeline(timelineId: string): object | null

getVersions(timelineId, filter?)

Signature:

getVersions(
    timelineId: string,
    filter?: {
        includeVoided?: boolean
    }
): object[]

getRatePlans(filter?)

Signature

getRatePlans(filter?: {
    timelineId?: string,
    type?: 'Original' | 'NewProduct' | 'UpdateProduct' | 'RemoveProduct',
    effectiveDate?: string,
    effectiveDateFrom?: string,
    effectiveDateTo?: string,
    includeVoided?: boolean
}): object[]

Example:

const updatedPlans = zqf.getRatePlans({
    type: 'UpdateProduct'
});

getRatePlansByAmendmentType(type, filter?)

Signature:

getRatePlansByAmendmentType(
    type: 'Original' | 'NewProduct' | 'UpdateProduct' | 'RemoveProduct',
    filter?: {
        timelineId?: string,
        effectiveDate?: string,
        effectiveDateFrom?: string,
        effectiveDateTo?: string,
        includeVoided?: boolean
    }
): object[]

Example:

const removedPlans = zqf.getRatePlansByAmendmentType('RemoveProduct');

getUpdatedRatePlans(filter?)

Signature:

getUpdatedRatePlans(filter?: object): object[]

getRemovedRatePlans(filter?)

Signature:

getRemovedRatePlans(filter?: object): object[]

getOriginalRatePlans(filter?)

Signature:

getOriginalRatePlans(filter?: object): object[]

Example:

const updated = zqf.getUpdatedRatePlans();
const removed = zqf.getRemovedRatePlans();
const original = zqf.getOriginalRatePlans();

getLatestVersion(timelineId, filter?)

Signature:

getLatestVersion(
    timelineId: string,
    filter?: {
        includeVoided?: boolean
    }
): object | null

getVersionByEffectiveDate(timelineId, effectiveDate, filter?)

Signature:

getVersionByEffectiveDate(
    timelineId: string,
    effectiveDate: string,
    filter?: {
        includeVoided?: boolean
    }
): object | null

Example:

const version = zqf.getVersionByEffectiveDate(timelineId, '2026-07-13');

getCharges(version, filter?)

Signature:

getCharges(
    version: object,
    filter?: {
        includeVoided?: boolean,
        action?: string,
        optional?: boolean
    }
): object[]

Example:

const charges = zqf.getCharges(version, {
    optional: false
});

getCharge(version, chargeIdOrKey)

Signature:

getCharge(version: object, chargeIdOrKey: string): object | null

Matches by charge id, preview charge id, or product rate plan charge id.

getTiers(charge)

Signature:

getTiers(charge: object): object[]

getTier(charge, tierIndexOrKey)

Signature:

getTier(
    charge: object,
    tierIndexOrKey: number | string
): object | null

Matches by index, tier id, or zqu__Tier__c.

getRampIntervals()

Signature:

getRampIntervals(): object[]

getActiveRampInterval()

Signature:

getActiveRampInterval(): object | null

Uses pageState.currentInterval when present. Falls back to the quote start date interval.

getRampIntervalByDate(date)

Signature:

getRampIntervalByDate(date: string | Date): object | null

Example:

const interval = zqf.getRampIntervalByDate('2026-07-13');

getAmendments(filter?)

Signature:

getAmendments(filter?: {
    timelineId?: string,
    type?: 'Original' | 'NewProduct' | 'UpdateProduct' | 'RemoveProduct',
    effectiveDate?: string,
    effectiveDateFrom?: string,
    effectiveDateTo?: string,
    includeVoided?: boolean
}): object[]

Example:

const removedAmendments = zqf.getAmendments({
    type: 'RemoveProduct'
});

getAmendment(timelineIdOrFilter, filter?)

Signature:

getAmendment(
    timelineIdOrFilter: string | {
        timelineId?: string,
        type?: 'Original' | 'NewProduct' | 'UpdateProduct' | 'RemoveProduct',
        effectiveDate?: string,
        effectiveDateFrom?: string,
        effectiveDateTo?: string,
        includeVoided?: boolean
    },
    filter?: object
): object | null

Returns the last matching amendment.

Example:

const amendment = zqf.getAmendment({
    timelineId,
    type: 'UpdateProduct'
});

getAmendmentRecord(amendment)

Signature:

getAmendmentRecord(amendment: object): object | null

getAmendmentType(version)

Signature:

getAmendmentType(version: object): string | null

Returns the normalized amendment type from the version.