Magidoc

ItemAddOn
Object

Fields

#

allowOveragesInd

Boolean !
Non-null

capReplaces

Boolean !
Non-null

The chosen tier sets the account's absolute limit (replaces the plan-included limit) rather than adding units.

description

String !
Non-null

featureUnlock

Boolean !
Non-null

Feature-unlock add-on: buying any tier grants the plan feature named by IncludedFeatureKey as a boolean entitlement (e.g. Engagement System). The tier's Cap is an enforcement contact limit, not a plan-allowance replacement.

fees

ItemAddOnFees !
Non-null

Fee information for add on.

freeCreditsAmt

Int !
Non-null

id

String !
Non-null

includedFeatureKey

String

For a cap-replace add-on: the KeyCode of the plan feature that supplies the plan-included base allowance the tiers raise (e.g. custom_domains). Null for add-ons with no included base. Read the account's tvafs limit for this key to show 'used of included'.

lifeTimeInd

Boolean !
Non-null

name

String !
Non-null

recurring

Boolean !
Non-null

Recurring add-on billed as a subscription item at the plan's interval (vs a one-time credit purchase).

type

AddOnType !
Non-null

Usages

#

References

#