Tier helpers
Helpers for updating product rate plan charge tiers and tier fields, with and without interval context.
updateTier(timelineId, chargeIdOrKey, tierIndexOrKey, patch)
Signature:
updateTier(
timelineId: string,
chargeIdOrKey: string,
tierIndexOrKey: number | string,
patch: object
): CustomEvent
Parameter | Type | Required | Description |
|---|---|---|---|
| Parameter | Type | Required | Description |
| timelineId | string | Yes | Target product timeline id. |
| chargeIdOrKey | string | Yes | Charge id or key. |
| tierIndexOrKey | number | string | Yes | Tier index, tier id, or zqu__Tier__c value. |
| patch | object | Yes | Tier field updates. |
Example:
this.dispatchEvent(
zqf.updateTier(timelineId, chargeIdOrKey, 1, {
zqu__Discount__c: 10
})
);
updateTierInInterval(intervalId, timelineId, chargeIdOrKey, tierIndexOrKey, patch)
Signature:
updateTierInInterval(
intervalId: number | string | object,
timelineId: string,
chargeIdOrKey: string,
tierIndexOrKey: number | string,
patch: object
): CustomEvent
Parameter | Type | Required | Description |
|---|---|---|---|
| intervalId | number | string | object | Yes | Interval index, interval start date, or interval object. |
| timelineId | string | Yes | Target product timeline id. |
| chargeIdOrKey | string | Yes | Charge id or key. |
| tierIndexOrKey | number | string | Yes | Tier index, tier id, or zqu__Tier__c value. |
| patch | object | Yes | Tier field updates. |
updateTierField(timelineId, chargeIdOrKey, tierIndexOrKey, fieldName, value)
Signature:
updateTierField(
timelineId: string,
chargeIdOrKey: string,
tierIndexOrKey: number | string,
fieldName: string,
value: any
): CustomEvent
Parameter | Type | Required | Description |
|---|---|---|---|
| timelineId | string | Yes | Target product timeline id. |
| chargeIdOrKey | string | Yes | Charge id or key. |
| tierIndexOrKey | number | string | Yes | Tier index, tier id, or zqu__Tier__c value. |
| fieldName | string | Yes | Exact tier field API name. |
| value | any | Yes | Value to assign. |
updateTierFieldInInterval(intervalId, timelineId, chargeIdOrKey, tierIndexOrKey, fieldName, value)
Signature:
updateTierFieldInInterval(
intervalId: number | string | object,
timelineId: string,
chargeIdOrKey: string,
tierIndexOrKey: number | string,
fieldName: string,
value: any
): CustomEvent
Parameter | Type | Required | Description |
|---|---|---|---|
| intervalId | number | string | object | Yes | Interval index, interval start date, or interval object. |
| timelineId | string | Yes | Target product timeline id. |
| chargeIdOrKey | string | Yes | Charge id or key. |
| tierIndexOrKey | number | string | Yes | Tier index, tier id, or zqu__Tier__c value. |
| fieldName | string | Yes | Exact tier field API name. |
| value | any | Yes | Value to assign. |