Skip to content

List prices

GET
/v1/prices
curl "https://api.summerbase.com/v1/prices" \
-H "Authorization: Bearer sb_..."

The prices of the project you are working in.

plan_id
string

Only the prices on this plan — a Summerbase id, or a source identity.

archived
boolean

Only archived prices, or only offered ones. Both, by default.

sort

The order: a key, - before it for descending, commas between up to 3 keys — -created_at, name, -mrr,name. The keys are created_at, name. Text sorts ignoring case; a record with no value for the key comes last, whichever way the list runs.

string

The order.

limit
integer
default: 20 >= 1 <= 100

How many records to return, 1 to 100. Defaults to 20.

cursor
string

The next_cursor of the previous page, to read the page after it.

include_total_count
boolean

Whether to add total_count, how many records match altogether. On the first page only: it is the same number on every page of one list, so keep the first page’s, and it is refused beside a cursor.

expand[]
Array<string>
<= 10 items
Allowed values: owner_source plan

Relationships to include in the response instead of fetching separately. A dotted path expands what an expanded record can expand in turn — at most 4 deep, 10 paths a request, and never back to a record already on the path.

Returns a list of price objects, a page at a time. See Pagination.

Media typeapplication/json

Example

{
"data": [
{
"archived": false,
"created_at": "2025-09-08T14:12:30Z",
"currency_code": "USD",
"id": "0198f1a4-2e5f-7b80-a1c2-3d4e5f6a7b8c",
"identities": [
"stripe:price_1PqR8sT2uV4wX6yZ"
],
"interval": "month",
"interval_count": 1,
"name": "Growth monthly",
"object": "price",
"owner_source_id": "0198f1a3-0b7c-7e25-9f41-6a2d8c3e5b19",
"plan_id": "0198f1a4-1d2e-7a40-9b31-5c6d7e8f9a0b",
"pricing_model": "fixed",
"properties": {
"tier": "mid"
},
"properties_by_source": {
"backend": {
"tier": "mid"
}
},
"unit_amount": "50.00"
}
],
"has_more": false,
"next_cursor": null,
"object": "list",
"total_count": 1
}