Skip to main content
GET
cURL
Get a plan with public price IDs and their automatic introductory offer IDs.

Authorizations

x-api-key
string
header
required

Headers

Commet-Version
string
default:2026-08-27

API version used by this reference. Send this header to select this contract explicitly.

Path Parameters

id
string
required

Response

Success

id
string
required
name
string
required
code
string
required
description
string | null
required
consumptionModel
enum<string> | null
required
Available options:
metered,
credits,
balance
isPublic
boolean
required
isDefault
boolean
required
isFree
boolean
required
blockOnExhaustion
boolean | null
required
sortOrder
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
planGroupId
string | null
required
metadata
object | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
features
object[]
required
prices
object[]
required
exchangeRates
object[]
required
object
string
required
Allowed value: "plan"
livemode
boolean
required