Skip to navigation

List price rule versions

Every version of one price rule, newest first, each read as the rule under that version: one not in force yet, scheduled with a later effective_from, is included, so a change your customers have notice of can be read before it applies.

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

price_rulestringRequired

The price rule ID (pr_...) or its key.

Query parameters

limitintegerOptional1-100Defaults to 20
Maximum number of objects to return, from 1 to 100.
cursorstringOptional

The next_cursor from the previous page.

Response

A page of versions.
object"list"
datalist of objects
has_moreboolean
next_cursorstringOptional

Errors

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