List the vendor price rows, current, upcoming and history

GET /v1/platform/vendor-prices

Every vendor price row in Provider, stage, model and unit order, and within one key with the latest effective_from first, each with its derived effective_until and its state at the read (1.38.0). state filters the current rows (in force), the upcoming ones or the history (ended and replaced). List prices, never bills; no content, so the read is not audited.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the platform:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/platform/vendor-prices" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/platform/vendor-prices`, {
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.get(
    f"{os.environ['VOCAL_API']}/v1/platform/vendor-prices",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Parameters

Responses

Fields of the 200 answer

The shape is VendorPriceList.