Price Tag Data ModelCopied!

The Price Tag object in the Nue Self-Service API provides a flexible framework for implementing various pricing strategies. Understanding its structure is essential for effective implementation.

Core Price Tag FieldsCopied!

id

• Unique identifier for the price tag

• System-generated UUID

• Example: "a0X7z000007CCkXEAW"

name

• Descriptive name of the price tag

• Should be meaningful for internal reference

• Example: "30% Volume Discount for Enterprise"

code

• Unique code for the price tag

• Used for coupon/promotion codes and API references

• Example: "ENTERPRISE30"

recordType

• Defines whether this is a price tag or discount tag

• Values: "PriceDimension" (sets price) or "DiscountDimension" (applies discount)

• Example: "DiscountDimension"

description

• Detailed explanation of the price tag

• Used for internal documentation

• Example: "30% discount for enterprise customers purchasing 100+ licenses"

Configuration FieldsCopied!

active

• Whether the price tag is currently active

• Boolean value

• Example: true

publishStatus

• Controls visibility in the self-service API

• Values: "Published", "Unpublished", "Outdated"

• Only "Published" tags appear in the API

• Example: "Published"

priceTagType

• Defines the basis for pricing rules

• Values: "Quantity" or "Term"

• Example: "Quantity"

priceType

• Defines how pricing is calculated across tiers

• Values: "Volume", "Tiered", or "Ramp"

• Example: "Volume"

uomDimension

• Unit of measure dimension this tag applies to

• For quantity-based tags: "User", "License", etc.

• For term-based tags: This field defines the dimension

• Example: "User"

startTime

• When this price tag becomes effective

• ISO datetime format

• Example: "2023-06-01T00:00:00Z"

endTime

• When this price tag expires

• ISO datetime format

• Optional - if not set, no expiration

• Example: "2023-12-31T23:59:59Z"

Publication FieldsCopied!

lastPublishedDate

• Date when this price tag was last published

• ISO date format

• Example: "2023-05-15"

lastPublishedById

• ID of the user who last published this price tag

• Example: "005E200000JjwfQIAR"

Price Tier StructureCopied!

Each price tag contains an array of priceTiers, which define the specific pricing rules:

chargeModel

• How the price/discount is applied

• Values: "PerUnit" or "FlatFee"

• Example: "PerUnit"

tierNumber

• Sequence number for the tier

• Integer value

• Example: 1

startUnit

• Beginning of this tier range

• Numeric value

• Example: 0

endUnit

• End of this tier range (optional for last tier)

• Numeric value

• Example: 100

startUnitDimension

• For term-based tags, the unit of time for start

• Values: "Day", "Month", "Quarter", "Year"

• Example: "Month"

endUnitDimension

• For term-based tags, the unit of time for end

• Values: "Day", "Month", "Quarter", "Year"

• Example: "Year"

amount

• Price amount for price tags or discount amount for discount tags

• Numeric value

• Example: 25.00

discountPercentage

• Percentage discount for discount tags

• Numeric value (negative indicates price increase)

• Example: 15

Upcoming Features to be SupportedCopied!

Custom fields on price tags