ResellerHQ
Log inTry the sandbox free
GuidesAPI reference
PricingPrice lists

Preview a price change

POST
/v1/price-lists/{id}/impact

Takes the changes you are thinking of making to a list and saves nothing. Says how many customers are on the list and, for up to 50 of the domains, licences and numbers they hold, what one unit of the next renewal costs them now and what it would cost after the change.

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

id*string

Request Body

application/json
  1. body
Default{}
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
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

Value in"USD""EUR""GBP""CAD""AUD""NZD""CHF""SEK""NOK""DKK""PLN""INR""SGD""HKD""AED""ZAR""BRL""MXN"
rate?integer

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

Range10000 <= value <= 100000000000
rules?array<>
Itemsitems <= 200
isDefault?true

Looks at making this the default list: the customers with no list of their own are counted too, at what they pay now

Value intrue

Response Body

Success

application/json
  1. response

Success

customers*integer

How many customers are on this list

items*integer

How many active domains, licences and numbers those customers hold

changed*integer

How many of the items in data would change price

data*array<>
curl -X POST "https://example.com/v1/price-lists/prl_01K6XJ4Q8ZT3M9R5V2B7WDHNCA/impact" \  -H "Content-Type: application/json" \  -d '{}'
{  "customers": 3,  "items": 12,  "changed": 4,  "data": [    {      "type": "number",      "id": "dom_01K6Z3M5T8Q2W4E6R8Y0U2I4O6",      "name": "northwind-telecom.com",      "customerId": "cus_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",      "cost": 1440,      "current": {        "cost": 1440,        "price": 1440,        "currency": "USD",        "priceUsd": 1440,        "ruleId": "prr_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",        "level": "override",        "floored": true,        "normalPrice": 1440,        "discount": 1440,        "promotion": {          "id": "prm_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",          "code": "LAUNCH25",          "endsAt": "2026-11-01T00:00:00.000Z"        }      },      "proposed": {        "cost": 1440,        "price": 1440,        "currency": "USD",        "priceUsd": 1440,        "ruleId": "prr_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",        "level": "override",        "floored": true,        "normalPrice": 1440,        "discount": 1440,        "promotion": {          "id": "prm_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",          "code": "LAUNCH25",          "endsAt": "2026-11-01T00:00:00.000Z"        }      }    }  ]}

Delete a price list DELETE

Customers on it go back to the default list.

Quote customer prices POST

Works out what a customer, or anyone on a list, pays for items at the wholesale prices given. Nothing is bought. With neither a customer nor a list, the default list. A customer's contract prices count; prices fixed on single items do not, since no item is named. A promotion everyone on the list gets is counted without asking; send `coupon` to see what the promotion behind a code would do. A coupon that cannot be used is simply not applied.