Skip to navigation
API ReferencePricing from costProvider price catalogPrices

Retrieve a catalog price version

One price version by its ID, as catalog.price_changed, a cost line and a rate card name it: the rates, the source, the date it takes effect and what changed from the version before. Needs config:read.

Authentication

AuthorizationBearer

A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.

Path parameters

catalog_pricestringRequired

The catalog price version ID (catp_...).

Response

The catalog price version.
idstring
object"catalog_price"
catalog_modelstring
The catalog model ID.
versioninteger
1 for the first version of a catalog model's prices, then one more for each change.
statusenum

scheduled: takes effect at effective_from. active: in force. superseded: replaced by a later version.

Allowed values:
currencystring
The currency the provider quotes. Runledger doesn't convert between currencies.
rateslist of objects
effective_fromdatetime
When these rates start to apply. It is never earlier than the day the version is published, and that includes a correction. Costs dated before it keep the earlier version, and recorded costs are never repriced.
as_ofdate
The date Runledger read these rates from the source.
source_urlstringformat: "uri"

Where the rates were read: the provider’s pricing page or its change notice.

published_atdatetime
When Runledger published this version, which can be before it takes effect. The freshness target is to publish a provider's price change within 1 business day of the provider publishing it. A business day is Monday to Friday in Sydney time, with no public holiday calendar.
last_verified_atdatetime
When Runledger last checked this version against its source.
effective_todatetimeOptional
When a later version replaced this one. Left out while it is in force.
source_referencestringOptional<=500 characters
A note on the source, such as the page title or the notice date.
changeslist of objectsOptional
What differs from the version before, rate by rate.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error