Skip to main content
PricesVersion: v3

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.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:products/prices.write
Auth methods:OAuthPrivate Integration
Token types:Sub-Account TokenAgency Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Path Parameters

productIdstringrequired

ID of the product that needs to be used

Example:6578278e879ad2646715ba9c

Body

namestringrequired

The name of the price.

Example:Price Name
typestringrequired

The type of the price.

Available optionsone_timerecurring
Example:one_time
currencystringrequired

The currency of the price.

Example:USD
amountnumberrequired

The amount of the price. ( min: 0 )

Example:99.99
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).

Example:7
totalCyclesnumber

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

Example:12
setupFeenumber

The setup fee for the price.

Example:10.99
variantOptionIdsstring[]

An array of variant option IDs associated with the price.

Example:["option_id_1","option_id_2"]
compareAtPricenumber

The compare at price for the price.

Example:19.99
locationIdstringrequired

The unique identifier of the location associated with the price.

Example:6578278e879ad2646715ba9c
userIdstring

The unique identifier of the user who created the price.

Example:6578278e879ad2646715ba9c
metaobject

Additional metadata associated with the price.

trackInventoryboolean

Need to track inventory stock quantity

Example:true
availableQuantitynumber

Available inventory stock quantity

Example:5
allowOutOfStockPurchasesboolean

Continue selling when out of stock

Example:true
skustring

The unique identifier of the SKU associated with the price

Example:sku_123
shippingOptionsobject

Shipping options of the Price

isDigitalProductboolean

Is the product a digital product

Example:true
digitalDeliverystring[]

Digital delivery options

Response

Successful response

_idstringrequired

The unique identifier for the price.

Example:655b33aa2209e60b6adb87a7
membershipOffersobject[]

An array of membership offers associated with the price.

variantOptionIdsstring[]

An array of variant option IDs associated with the price.

Example:["h4z7u0im2q8","h3nst2ltsnn"]
locationIdstring

The unique identifier for the location.

Example:3SwdhCsvxI8Au3KsPJt6
productstring

The unique identifier for the associated product.

Example:655b33a82209e60b6adb87a5
userIdstring

The unique identifier for the user.

Example:6YAtzfzpmHAdj0e8GkKp
namestringrequired

The name of the price.

Example:Red / S
typestringrequired

The type of the price (e.g., one_time).

Available optionsone_timerecurring
Example:one_time
currencystringrequired

The currency code for the price.

Example:INR
amountnumberrequired

The amount of the price.

Example:199999
recurringobject

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

createdAtstring<date-time>

The creation timestamp of the price.

Example:2023-11-20T10:23:38.645Z
updatedAtstring<date-time>

The last update timestamp of the price.

Example:2024-01-23T09:57:04.852Z
compareAtPricenumber

The compare-at price for comparison purposes.

Example:2000000
trackInventoryboolean

Indicates whether inventory tracking is enabled.

Example:null
availableQuantitynumber

Available inventory stock quantity

Example:5
allowOutOfStockPurchasesboolean

Continue selling when out of stock

Example:true