Get a plan

GET

/v1/plans/:id

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

Fetch one plan, by Summerbase id or by any source’s id for it.

Parameters

Path Parameters

id

required

string

The plan’s Summerbase id, or an identity ref: a source slug and that source’s own id for it, joined by a colon — stripe:prod_123.

Example

0198f1a4-1d2e-7a40-9b31-5c6d7e8f9a0b

Query Parameters

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 the plan object.

Media typeapplication/json

Example

{
  "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"
    }
  }
}