Skip to main content
POST
Query prices

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Filter

allow_expired_prices
boolean
default:false
billing_periods
enum<string>[]
Available options:
MONTHLY,
ANNUAL,
WEEKLY,
DAILY,
QUARTERLY,
HALF_YEARLY,
ONETIME
end_time
string<date-time>
entity_ids
string[]
entity_type
enum<string>
Available options:
PLAN,
SUBSCRIPTION,
ADDON,
PRICE,
COSTSHEET
expand
string
filters
object[]

DSL filters

limit
integer
Required range: 1 <= x <= 1000
meter_ids
string[]
offset
integer
Required range: x >= 0
order
enum<string>
Available options:
asc,
desc
parent_price_id
string
plan_ids
string[]

Price override filtering fields

price_ids
string[]
sort
string
start_date_lt
string
start_time
string<date-time>
status
enum<string>
Available options:
published,
deleted,
archived
subscription_id
string

Response

OK

items
object[]
pagination
object