Prices

Query prices

Changed on

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

post/prices/search

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/prices/search
  • Auth
    API key in header x-api-key

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
updated_afterstring

UpdatedAfter matches prices edited since the given time. TimeRangeFilter above filters on created_at, so it cannot see an edit to an existing price.

Response

OK

Changes