Skip to main content
GET
List

Authorizations

Authorization
string
header
required

API key authentication

Query Parameters

billableMetricId
string

Filter prices by billable metric ID Unique identifier for a billable metric

Pattern: ^bm_[a-zA-Z0-9]+$
merchantId
string

Filter prices by merchant organization ID. Matches prices reached via either a billable metric or a fee belonging to that merchant. Unlike the unfiltered listing, this includes prices whose billable metric or fee has been deleted — deleting a parent does not delete its prices, and they can still bill. Returns 404 if the merchant does not exist. Unique identifier for an organization

Pattern: ^org_[a-zA-Z0-9]+$
limit
integer
default:10

Number of prices to return

Required range: 1 <= x <= 100
offset
integer
default:0

Number of prices to skip

Required range: x >= 0
includeSuperseded
boolean
default:false

Include a price that is only an older rate of a slot a live plan bills today. It still bills subscriptions pinned to its version, so set this to list every price that can bill.

Response

List of prices

data
object[]
pagination
object