AccountPlanAddOn

Object

capReplaces

The tier sets an absolute cap that replaces the plan-included limit (vs adding units). For these, Credits is the effective cap and QtyUsed is the units in use.

creditPrice

Add-on credit price.

credits

Add-on credits.

endsUtc

When a cancelled add-on's paid term actually runs out, i.e. the date the account keeps its capacity/credits through. NOT the plan's term end: an add-on billed on its own subscription ends on that subscription's period end, which can be many months past the plan's renewal. Null when the add-on is not scheduled to end.

enforcementState

For a feature-unlock add-on with contact-limit enforcement: 0 OK, 1 Approaching (80-99%), 2 Grace (over cap, still scoring), 3 Paused (grace ended, scoring stopped, existing data preserved). 0 when not owned/enforced.

featureUnlock

Feature-unlock add-on (e.g. Engagement System): buying any tier grants a plan feature; the tier's Cap (Credits) is an enforcement contact limit and QtyUsed is the current active contact count. Selects the tier render + enforcement banner in the client.

freeCreditsInd

Indicates if this add-on has free credits

graceEndsUtc

For a feature-unlock add-on in the Grace state: the upgrade-by deadline before scoring pauses. Null otherwise.

id

Unique add-on id

includedBase

For a cap-replace add-on: the plan-INCLUDED base allowance (e.g. 50 domains) the add-on tiers raise. Effective cap (Credits) = max(IncludedBase, purchased tier). 0 when the plan includes no base.

name

Name of add-on

overageFee

Overage fee of add-on based on quantity of credits used (updated daily).

pendingChangeType

Add-on pending change type. Will be null if there is no change.

pendingEffectiveUtc

When a scheduled tier downgrade takes effect (the add-on's next bill date). Null when no downgrade is scheduled.

pendingQty

For an add-on with a scheduled tier DOWNGRADE: the lower cap that takes effect at the next renewal. Credits still reports the cap in force until then, because the account paid for it through the term. Null when no downgrade is scheduled.

qtyUsed

Quantity of credits used (updated daily).

recurring

Recurring add-on billed as a subscription item at the plan's interval (vs a one-time credit purchase). Selects the tier/cap render in the client.

renewsUtc

When this add-on next bills. NOT always the plan's renewal date: a monthly add-on on an annual plan is billed on its own subscription and renews on its own monthly cycle. Null for an add-on that never bills again (free tier, lifetime allotment, or one ending).

storageDays

Only set for Transaction Email add-on

storageDaysPrice

Only set for Transaction Email add-on

tiers

For a cap-replace add-on: the purchasable tiers resolved for THIS account's plan (so an AppSumo account gets its LTD tiers, a paid account the standard ones). Empty for credit add-ons.

totalPrice

Total price of add-on

type

Type of add-on

unitOfMeasure

The unit noun for a cap-replace add-on's cap (e.g. "domains").