List plans

GET

/v1/plans

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

The plans of the project you are working in.

Parameters

Query Parameters

archived

boolean

Only archived plans, 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: prices

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.

Response

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

Media typeapplication/json

Example

{
  "data": [
    {
      "archived": false,
      "created_at": "2025-09-08T14:12:30Z",
      "id": "0198f1a4-1d2e-7a40-9b31-5c6d7e8f9a0b",
      "identities": [
        "stripe:prod_QhR2sT4uV6wX8y"
      ],
      "name": "Growth",
      "object": "plan",
      "price_count": 2,
      "properties": {
        "tier": "mid"
      },
      "properties_by_source": {
        "backend": {
          "tier": "mid"
        }
      }
    }
  ],
  "has_more": false,
  "next_cursor": null,
  "object": "list",
  "total_count": 1
}