Objects

The documentation below describes the API as of version 9.x of the script.

Public properties or functions that are not in the discountNinja.api namespace should be considered obsolete and will be removed in the next major version release.

Using undocumented functions or objects will result in issues as custom code that relies on those functions or objects may break in the future when Discount Ninja's script is automatically updated.

Note that the properties of the objects made available by the API should be considered read-only. To modify the state of the object's properties, the user can:

• call one of the available functions

• publish one of the available events

Product variant price info

amount	number	The discount amount, expressed in cents.
discountCode	string	The offer token, Shopify discount code or promotion code associated with the applied discount.
discountedPrice	number	The discounted price, expressed in cents.
isCurrentProduct	boolean	true if the user is on a product page that matches the handle for this object
isDiscountedByOffer	boolean	true if the variant is discounted by a Discount Ninja offer (not, for example, a compare-at price).
offerToken	string	The token of the offer associated with the applied discount.
originalPrice	number	The original price (i.e. the price before discounts are applied), expressed in cents.
percentage	number	The discount percentage.
productHandle	string	The handle of the product associated with the object.
sellingPlan	number | null	The id of the selected selling plan for subscription products. Null for one-time purchases.
promotionToken	string	The token of the promotion associated with the applied discount.
variantId	number | null	The id of the selected variant. Null if the variant is not known, for example for products on collection pages.