Skip to main content
GET
List Prices

Authorizations

Authorization
string
header
required

Use a Bearer token to access this API.

Query Parameters

limit
integer<int32> | null

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Example:

10

offset
integer<int32> | null

Number of objects to skip before returning results.

Example:

3

active
boolean | null

Only return prices where active matches this value.

Example:

false

product
string | null

Filter by product ID to return prices for a specific product.

Example:

"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

expand_product
boolean | null

If true, expands the product object in the response.

Example:

false

starting_after
string | null

A cursor for use in pagination. starting_after is a price ID that defines your place in the list. For instance, if you make a list request and receive 20 prices, ending with fprice_xyz, your subsequent call can include starting_after=fprice_xyz to fetch the next page.

Example:

"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

ending_before
string | null

A cursor for use in pagination. ending_before is a price ID that defines your place in the list. For instance, if you make a list request and receive 20 prices, starting with fprice_abc, your subsequent call can include ending_before=fprice_abc to fetch the previous page.

Example:

"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

metadata
object

Filter by metadata key-value pairs using bracket syntax. For example: metadata[lookup_key]=premium-plan. Multiple keys use AND logic.

Example:

Response

An envelope wrapping a list of price objects.

An envelope wrapping a list of price objects.

prices
object[]
required

The list of prices.