Prices

Query prices

Use when listing or searching prices (e.g. plan builder or catalog). Returns a paginated list; supports filtering and sorting.

post/prices/search

Request body

allow_expired_pricesboolean

billing_periodsTypesBillingPeriod[]

end_timestring date-time

entity_idsstring[]

entity_type'PLAN' | 'SUBSCRIPTION' | 'ADDON' | 'PRICE' | 'COSTSHEET'

expandstring

limitinteger

meter_idsstring[]

offsetinteger

order'asc' | 'desc'

parent_price_idstring

plan_idsstring[]

Price override filtering fields

price_idsstring[]

sortstring

start_date_ltstring

start_timestring date-time

status'published' | 'deleted' | 'archived'

subscription_idstring

Response

Changes

Changed in 8 of the 12 revisions of this API.21319

Jun 29, 2026cef2964c102c23See the full diff
- ●
  added the new config enum value to the items/items/addon/entitlements/items/feature/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new config enum value to the items/items/addon/entitlements/items/feature_type response property for the response status 200
  response-property-enum-value-added
- ○
  added the new optional request property billing_periods
  new-optional-request-property
- ○
  added the optional property items/items/addon/entitlements/items/config_value to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/items/sequence to the response with the 200 status
  response-optional-property-added
May 18, 2026f62d8a5fe7cf4See the full diff
- ●
  removed the optional property details from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property details from the response with the 500 status
  response-optional-property-removed
- ●
  added the new too_many_requests enum value to the code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new too_many_requests enum value to the code response property for the response status 500
  response-property-enum-value-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 18, 20260cb3425d658021See the full diff
- ●
  removed the optional property items/items/addon/type from the response with the 200 status
  response-optional-property-removed
- ●
  added the new ONETIME enum value to the items/items/billing_period response property for the response status 200
  response-property-enum-value-added
- ○
  removed the ONETIME enum value from the items/items/billing_cadence response property for the response status 200
  response-property-enum-value-removed
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 23, 202682f205e0f42911See the full diff
- ●
  removed the optional property items/items/trial_period from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property items/items/trial_period_days to the response with the 200 status
  response-optional-property-added
Apr 6, 20264ded3711f40148See the full diff
- ●
  removed the optional property error from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property error from the response with the 500 status
  response-optional-property-removed
- ●
  removed the optional property success from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property success from the response with the 500 status
  response-optional-property-removed
- ○
  added the optional property code to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property code to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property http_status_code to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property http_status_code to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 500 status
  response-optional-property-added
This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 4, 2026d1860fe0ee672See the full diff
- ▲
  the end_time request property type/format changed from string/ to string/date-time
  request-property-type-changed
- ▲
  the start_time request property type/format changed from string/ to string/date-time
  request-property-type-changed
This revision also has 223 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 20, 2026bc91c95fbb1a5See the full diff
- ○
  added the optional property items/items/addon/entitlements/items/feature/group to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/items/addon/entitlements/items/feature/group_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/items/addon/entitlements/items/feature/meter/aggregation/expression to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/items/addon/entitlements/items/feature/reporting_unit to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/items/meter/aggregation/expression to the response with the 200 status
  response-optional-property-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 27, 2026152f346e42411See the full diff
- ○
  endpoint added
  endpoint-added

Full history