Get cost configuration

Return the account’s cost configuration. Use ?type= to filter to a single cost type; omit it to get the full bag.

Required scope: costs:read.

GET /accounts/api/costs

Get cost configuration

cURL

curl --request GET \
  --url https://api.upstackdata.com/accounts/api/costs \
  --header 'x-api-key: <api-key>' \
  --header 'x-pixel-id: <api-key>'

200

{}

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.

Query Parameters

type · enum<string>

Filter to a single cost type. Cost configuration type. Used to filter /api/costs.

Available options: global_product_override, order, gateway, shipping, variable, fixed

Response

200

application/json

The cost configuration (or the filtered subset).

Shape depends on ?type= — without a filter, returns the full configuration bag keyed by cost type.