List prices

​

A client-facing price for a product, Stripe-shaped: one number in minor units (or a tier list), never a formula. Optionally for one ensemble (the 10-piece’s reception price). Write-once once sold: retire with status and mint another.

Query Parameters

  • Page size, 50 by default, 200 at most.

  • Records to skip.

  • Comma-separated fields; prefix with - for descending. Sortable: label, status, order, lookup_key, billing_scheme, unit_amount, currency, tiers, tiers_mode, product_id, ensemble_id, created_time, last_edited_time, id. Default: order,unit_amount.

  • Comma-separated subset of fields to return. id is always included.

  • Shorthand filter[label]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.

  • Shorthand filter[status]=value means equals. Operators: equals, does_not_equal, is_empty, is_not_empty.

  • Shorthand filter[order]=value means equals. Operators: equals, does_not_equal, greater_than, less_than, greater_than_or_equal_to, less_than_or_equal_to, is_empty, is_not_empty.

  • Shorthand filter[lookup_key]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.

  • Shorthand filter[billing_scheme]=value means equals. Operators: equals, does_not_equal, is_empty, is_not_empty.

  • Shorthand filter[unit_amount]=value means equals. Operators: equals, does_not_equal, greater_than, less_than, greater_than_or_equal_to, less_than_or_equal_to, is_empty, is_not_empty.

  • Shorthand filter[currency]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.

  • Shorthand filter[tiers]=value means equals. Operators: equals, does_not_equal, is_empty, is_not_empty.

    Shorthand filter[tiers]=value means equals. Operators: equals, does_not_equal, is_empty, is_not_empty.

  • Shorthand filter[tiers_mode]=value means equals. Operators: equals, does_not_equal, is_empty, is_not_empty.

  • Shorthand filter[product_id]=value means equals. Operators: equals, does_not_equal, is_empty, is_not_empty.

  • Shorthand filter[ensemble_id]=value means equals. Operators: equals, does_not_equal, is_empty, is_not_empty.

  • Shorthand filter[created_time]=value means equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.

  • Shorthand filter[last_edited_time]=value means equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.

Responses

  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/prices
curl 'https://api.hireorpheus.com/api/v1/prices?limit=50&offset=0&sort=order%2Cunit_amount' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "label": null,
      "status": "active",
      "order": null,
      "lookup_key": null,
      "billing_scheme": "per_unit",
      "unit_amount": null,
      "currency": null,
      "tiers": null,
      "tiers_mode": "graduated",
      "product_id": null,
      "ensemble_id": null,
      "created_time": "2026-10-14T08:02:53.595Z",
      "last_edited_time": "2026-10-14T08:02:53.595Z"
    }
  ],
  "meta": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}