Skip to main content
The PriceCreate event fires each time a new price is attached to a product in a sub-account. Prices define how a product is sold — one-time, recurring, or linked to specific variant options. Use this event to sync pricing to external catalogs, update billing system configurations, or trigger promotions when introductory prices are introduced.

Payload

FieldTypeDescription
_idstringUnique identifier for the price
locationIdstringSub-account ID where the price was created
productstringID of the product this price belongs to
userIdstringID of the user who created the price
namestringDisplay name for the price (e.g., "Red / S")
priceTypestringPricing model — one_time for a single charge or recurring for subscriptions
currencystringISO 4217 currency code (e.g., USD, INR)
amountnumberPrice amount in the smallest currency unit (e.g., cents for USD)
compareAtPricenumberOriginal or strikethrough price used to show a discount
availableQuantitynumberNumber of units available at this price; 0 means unlimited
allowOutOfStockPurchasesbooleanWhether purchases are allowed when stock is depleted
variantOptionIdsarrayList of variant option IDs this price applies to (e.g., specific size/color combinations)
membershipOffersarrayMembership offers linked to this price, each with a label, value, and _id
recurringobjectRecurring billing configuration — interval (e.g., day, month) and intervalCount
recurring.intervalstringBilling frequency unit (e.g., day, week, month, year)
recurring.intervalCountnumberNumber of interval units between each billing cycle
createdAtstringISO 8601 timestamp when the price was created
updatedAtstringISO 8601 timestamp of the most recent 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",
  "priceType": "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
}
Last modified on March 4, 2026