Skip to main content
GET
Get list rate by slug

Authorizations

X-Api-Key
string
header
required

Path Parameters

listRateSlug
string
required

List rate slug

Response

OK

data
object

The wire contract for a list rate, AT THE LATEST VERSION.

This is the single source of truth: toListRateResponse is annotated to return it (so the code cannot drift from it without a compile error), and the OpenAPI spec + docs + breaking-change gate are all generated from it.

Dates are ISO-8601 strings — the real wire form res.json produces from the underlying Moment values.

Nested relations carry their own versioned response contract where one exists (prices); otherwise they are unknown for now and become typed $refs in the full rollout.

success
boolean