HighLevel: Get Price by ID for a Product

← Products operations · Get started

Operation gohighlevel.get_price_by_id_for_product

Provider route: GET /products/{productId}/price/{priceId}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["products"]["getPriceByIdForProduct"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.products.getPriceByIdForProduct(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.products.get_price_by_id_for_product(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.productId	string	Required within parent
path.priceId	string	Required within parent
query	object	Required within parent	Additional keys: not allowed
query.locationId	string	Required within parent

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Create Price for a Product — response body

Referenced models: Create Price for a Product — response body

Schemas

Create Price for a Product — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier for the price.
allowOutOfStockPurchases	boolean	Optional	Continue selling when out of stock
amount	JSON	Required within parent
amount (anyOf 1)	number	Alternative	The amount of the price.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
availableQuantity	JSON	Optional
availableQuantity (anyOf 1)	number	Alternative	Available inventory stock quantity
availableQuantity (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
compareAtPrice	JSON	Optional
compareAtPrice (anyOf 1)	number	Alternative	The compare-at price for comparison purposes.
compareAtPrice (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdAt	string	Optional	The creation timestamp of the price. Format: date-time
currency	string	Required within parent	The currency code for the price.
locationId	string	Optional	The unique identifier for the location.
membershipOffers	array	Optional	An array of membership offers associated with the price.
membershipOffers[]	Model	Each item	Expand Create Price for a Product — response body — membership Offers item
name	string	Required within parent	The name of the price.
product	string	Optional	The unique identifier for the associated product.
recurring	JSON	Optional	The recurring details of the price (if type is recurring).
recurring (allOf 1)	Model	All variants apply	Expand Create Price for a Product — response body — recurring / interval: day, month, week, year
trackInventory	boolean	Optional	Indicates whether inventory tracking is enabled.
type	string	Required within parent	The type of the price (e.g., one_time). Known values: one_time, recurring
updatedAt	string	Optional	The last update timestamp of the price. Format: date-time
userId	string	Optional	The unique identifier for the user.
variantOptionIds	array	Optional	An array of variant option IDs associated with the price.
variantOptionIds[]	string	Each item

Referenced models: Create Price for a Product — response body — membership Offers item, Create Price for a Product — response body — recurring / interval: day, month, week, year

Create Price for a Product — response body — membership Offers item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	The unique identifier for the membership offer.
label	string	Required within parent	Membership offer label
value	string	Required within parent	Membership offer label

Create Price for a Product — response body — recurring / interval: day, month, week, year

Field	Type	Presence	Description and constraints
$	object	Root
interval	string	Required within parent	The interval at which the recurring event occurs. Known values: day, month, week, year
intervalCount	JSON	Required within parent
intervalCount (anyOf 1)	number	Alternative	The number of intervals between each occurrence of the event.
intervalCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_price_by_id_for_product. Catalog operation: get-price-by-id-for-product. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["products/prices.readonly"]

Pinned headers: {"Version": "v3"}

Official provider source