Create a price list

POST
/v1/price-lists

Your first list becomes the default for every customer.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.

Request Body

application/json
  1. body
name*string
Length1 <= length <= 80
markupBps?integer

Markup over wholesale for anything no rule covers, in basis points

Range0 <= value <= 1000000
Default0
rounding?string

99 and 00 round worked-out prices up to the next amount ending that way

Default"none"
Value in"99""none""00"
allowBelowCost?boolean
Defaultfalse
renewals?string

follow prices each renewal from the list as it is then; hold charges what the customer last paid for that item

Default"follow"
Value in"follow""hold"
currency?string

The currency customers on this list are charged in

Match^[A-Z]{3}$
Default"USD"
rate?integer

How much of currency one US dollar buys, in millionths. Needed for any currency but USD

Range10000 <= value <= 100000000000
isDefault?boolean
rules?array<>
Itemsitems <= 200
Default[]

Response Body

Created

application/json
  1. response

Created

id*string
name*string
Length1 <= length <= 80
markupBps*integer

Markup over wholesale for anything no rule covers, in basis points

Range0 <= value <= 1000000
rounding*string

99 and 00 round worked-out prices up to the next amount ending that way

Value in"99""none""00"
allowBelowCost*boolean

False raises any price that would sit under wholesale up to wholesale

renewals*string

follow prices each renewal from the list as it is then; hold charges what the customer last paid for that item

Value in"follow""hold"
currency*string

The currency customers on this list are charged in

Match^[A-Z]{3}$
rate*integer

How much of the currency one US dollar buys, in millionths: 920000 is 0.92. Always 1000000 for USD

isDefault*boolean

The list for customers with none of their own

rules*array<>
customers*integer

How many customers are on this list

actor*|

Who created or last updated this list

createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
curl -X POST "https://example.com/v1/price-lists" \  -H "Content-Type: application/json" \  -d '{    "name": "Agency"  }'
{  "id": "prl_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",  "name": "Agency",  "markupBps": 2000,  "rounding": "99",  "allowBelowCost": true,  "renewals": "follow",  "currency": "USD",  "rate": 1000000,  "isDefault": true,  "rules": [    {      "id": "prr_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",      "product": "number",      "match": "com",      "term": "30d",      "action": "new",      "minQuantity": 10,      "kind": "markup",      "value": 2500    }  ],  "customers": 3,  "actor": {    "kind": "user",    "label": "string"  },  "createdAt": "2026-10-07T11:04:31.000Z",  "updatedAt": "2026-10-07T11:04:31.000Z"}