Get the resolved cost for a variant

Returns the effective per-unit cost for a single variant, including which configuration tier supplied it (per-variant COG line, global override, or default fallback).

Required scope: costs:read.

GET /accounts/api/products/{productId}/{variantId}/cost

Get the resolved cost for a variant

cURL

curl --request GET \
  --url https://api.upstackdata.com/accounts/api/products/{productId}/{variantId}/cost \
  --header 'x-api-key: <api-key>' \
  --header 'x-pixel-id: <api-key>'

200

{
  "productCost": {
    "effectiveCost": 123,
    "handlingFee": 123,
    "currency": "<string>",
    "activeCogLine": {
      "id": "<string>",
      "cost": 123,
      "effectiveStartDate": "<string>",
      "effectiveEndDate": "<string>",
      "description": "<string>"
    }
  }
}

Authorizations

x-api-key · string · header · required

Your Upstack API key. Starts with upstack_.

x-pixel-id · string · header · required

The pixel id the request targets.

Path Parameters

productId · string · required

variantId · string · required

Response

200

application/json

The resolved cost breakdown.

productCost · object · required

The resolved cost breakdown for a single variant at the current moment. effectiveCost is what the COGS recalculation flow uses; source tells you whether it came from a per-variant COG line, the global override, or the default fallback.

Show child attributes