Skip to main content
The PriceUpdate event fires whenever a price record is changed — for example, when the amount, currency, compare-at price, available quantity, or recurring interval is edited. Use this event to keep external storefronts, billing systems, and pricing analytics in sync without polling the API.

Payload

FieldTypeDescription
_idstringUnique identifier for the price
locationIdstringSub-account ID where the price resides
productstringID of the product this price belongs to
userIdstringID of the user who last updated the price
namestringDisplay name for the price (e.g., "Red / S")
typestringPricing model — one_time for a single charge or recurring for subscriptions
currencystringISO 4217 currency code (e.g., USD, INR)
amountnumberUpdated price amount in the smallest currency unit
compareAtPricenumberOriginal or strikethrough price used to show a discount
availableQuantitynumberUpdated number of units available at this price
allowOutOfStockPurchasesbooleanWhether purchases are allowed when stock is depleted
variantOptionIdsarrayList of variant option IDs this price applies to
membershipOffersarrayMembership offers linked to this price, each with a label, value, and _id
recurringobjectUpdated recurring billing configuration — interval and intervalCount
createdAtstringISO 8601 timestamp when the price was originally created
updatedAtstringISO 8601 timestamp of this update

Example payload

{
  "_id": "655b33aa2209e60b6adb87a7",
  "membershipOffers": [
    { "label": "top_50", "value": "50", "_id": "655b33aa2209e60b6adb87a7" }
  ],
  "variantOptionIds": ["h4z7u0im2q8", "h3nst2ltsnn"],
  "locationId": "3SwdhCsvxI8Au3KsPJt6",
  "product": "655b33a82209e60b6adb87a5",
  "userId": "6YAtzfzpmHAdj0e8GkKp",
  "name": "Red / S",
  "type": "one_time",
  "currency": "INR",
  "amount": 199999,
  "recurring": { "interval": "day", "intervalCount": 1 },
  "createdAt": "2023-11-20T10:23:38.645Z",
  "updatedAt": "2024-01-23T09:57:04.852Z",
  "compareAtPrice": 2000000,
  "availableQuantity": 5,
  "allowOutOfStockPurchases": true
}
  • Price Create — fires when a new price is added
  • Price Delete — fires when a price is removed
  • Products API — create, retrieve, and manage products and prices programmatically
Last modified on March 4, 2026