PricingPromotions

List promotions

GET
/v1/promotions

Every offer you have run, newest first. An account holds at most 200 of them, so they all come back at once.

Authorization

apiKey
headerAuthorizationBearer <token>

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

Query Parameters

priceListId?string

Only offers on this list

status?string

scheduled has not started, live is running now, ended is past its dates and used_up has been used as often as it allows

Value in"scheduled""live""ended""used_up"

Response Body

The offers you have run

application/json
  1. response

The offers you have run

data*array<>
curl -X GET "https://example.com/v1/promotions?priceListId=prl_01K6XJ4Q8ZT3M9R5V2B7WDHNCA"
{  "data": [    {      "id": "prm_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",      "name": "Launch offer on .com",      "priceListId": "prl_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",      "product": "number",      "match": "com",      "matches": [        "com",        "net",        "org"      ],      "term": "30d",      "applies": "new",      "kind": "fixed",      "value": 2500,      "startsAt": "2026-10-07T11:04:31.000Z",      "endsAt": "2026-12-01T00:00:00.000Z",      "code": "LAUNCH25",      "maxUses": 100,      "maxPerCustomer": 1,      "allowBelowCost": true,      "status": "scheduled",      "uses": 12,      "discountUsd": 1440,      "createdAt": "2026-10-07T11:04:31.000Z",      "updatedAt": "2026-10-07T11:04:31.000Z"    }  ]}