Skip to main content
PricesVersion: v3

Get Price by ID for a Product

GET/products/{productId}/price/{priceId}

The "Get Price by ID for a Product" API allows retrieving information for a specific price associated with a particular product using its unique identifier. Use this endpoint to fetch details for a single price based on the provided price ID and product ID.

Authorizations

Authorizationstringheaderrequired

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

Scope:products/prices.readonly
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
priceIdstringrequired

ID of the price that needs to be returned

Example:6578278e879ad2646715ba9c

Query Parameters

locationIdstringrequired

location Id

Example:6578278e879ad2646715ba9c

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