Magidoc

AddOnEstimate
Object

No-charge estimate for changing a recurring cap-replace add-on (e.g. branded domains) so the UI can show exactly what will be charged now.

Fields

#

amountDueNow

Float !
Non-null

Net amount charged now.

creditApplied

Float !
Non-null

Account balance credit applied to this change.

currencyCode

String !
Non-null

fullPrice

Float !
Non-null

The tier's list price for the account's billing term (what it renews at).

interval

String !
Non-null

Billing interval the price is for: "month" or "year".

isNewSubscription

Boolean !
Non-null

True when the add-on starts a brand-new subscription (lifetime/AppSumo) billed in full now.

prorated

Boolean !
Non-null

True when the amount due is a proration of the remaining period (an existing subscription); false when billed in full now (a new lifetime subscription).

renewalUtc

DateTime

When the full price next applies (the current term end).

subtotal

Float !
Non-null

Prorated charge for the rest of the current period, before any account credit (equals FullPrice for a new lifetime subscription).

Usages

#

References

#