Create Price for a Product

POST 
/products/:productId/price

The "Create Price for a Product" API allows adding a new price associated with a specific product to the system. Use this endpoint to create a price with the specified details for a particular product. Ensure that the required information is provided in the request payload.

Request

Version stringrequired

API Version

Available optionsv3

productId stringrequired

ID of the product that needs to be used

application/json

application/json

Body

Bodyrequired

namestringrequired

The name of the price.

typestringrequired
The type of the price.
Available optionsone_timerecurring
currencystringrequired

The currency of the price.

amountnumberrequired

The amount of the price. ( min: 0 )

recurringobject

The recurring details of the price (if type is recurring).

descriptionstring

A brief description of the price.

membershipOffersobject[]

An array of membership offers associated with the price.

trialPeriodnumber

The trial period duration in days (if applicable).

totalCyclesnumber

The total number of billing cycles for the price. ( min: 1 )

setupFeenumber

The setup fee for the price.

variantOptionIdsstring[]

An array of variant option IDs associated with the price.

compareAtPricenumber

The compare at price for the price.

locationIdstringrequired

The unique identifier of the location associated with the price.

userIdstring

The unique identifier of the user who created the price.

metaobject

Additional metadata associated with the price.

trackInventoryboolean

Need to track inventory stock quantity

availableQuantitynumber

Available inventory stock quantity

allowOutOfStockPurchasesboolean

Continue selling when out of stock

skustring

The unique identifier of the SKU associated with the price

shippingOptionsobject

Shipping options of the Price

isDigitalProductboolean

Is the product a digital product

digitalDeliverystring[]

Digital delivery options

Example (auto)

{
  "name": "Price Name",
  "type": "one_time",
  "currency": "USD",
  "amount": 99.99,
  "recurring": {
    "interval": "day",
    "intervalCount": 1
  },
  "description": "string",
  "membershipOffers": [
    {
      "label": "top_50",
      "value": "50",
      "_id": "655b33aa2209e60b6adb87a7"
    }
  ],
  "trialPeriod": 7,
  "totalCycles": 12,
  "setupFee": 10.99,
  "variantOptionIds": [
    "option_id_1",
    "option_id_2"
  ],
  "compareAtPrice": 19.99,
  "locationId": "6578278e879ad2646715ba9c",
  "userId": "6578278e879ad2646715ba9c",
  "meta": {
    "source": "stripe",
    "sourceId": "123",
    "stripePriceId": "price_123",
    "internalSource": "agency_plan"
  },
  "trackInventory": true,
  "availableQuantity": 5,
  "allowOutOfStockPurchases": true,
  "sku": "sku_123",
  "shippingOptions": {
    "weight": {
      "value": 10,
      "unit": "kg"
    },
    "dimensions": {
      "height": 10,
      "width": 10,
      "length": 10,
      "unit": "cm"
    }
  },
  "isDigitalProduct": true,
  "digitalDelivery": [
    "string"
  ]
}

application/json

Successful response

application/json

Schema

Schema

_idstringrequired

The unique identifier for the price.

membershipOffersobject[]

An array of membership offers associated with the price.

variantOptionIdsstring[]

An array of variant option IDs associated with the price.

locationIdstring

The unique identifier for the location.

productstring

The unique identifier for the associated product.

userIdstring

The unique identifier for the user.

namestringrequired

The name of the price.

typestringrequired
The type of the price (e.g., one_time).
Available optionsone_timerecurring
currencystringrequired

The currency code for the price.

amountnumberrequired

The amount of the price.

recurringobject

The recurring details of the price (if type is recurring).

createdAtstring<date-time>

The creation timestamp of the price.

updatedAtstring<date-time>

The last update timestamp of the price.

compareAtPricenumber

The compare-at price for comparison purposes.

trackInventoryboolean

Indicates whether inventory tracking is enabled.

availableQuantitynumber

Available inventory stock quantity

allowOutOfStockPurchasesboolean

Continue selling when out of stock

Example (auto)

{
  "_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,
  "trackInventory": null,
  "availableQuantity": 5,
  "allowOutOfStockPurchases": true
}