Skip to main content
GET
Get plan version
Get one published version of a plan with its prices and how many subscriptions are on it.

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
versionId
string
required

Response

Success

id
string
required

Public plan version ID.

label
string
required

The plan's versions are numbered 1, 2, 3; an experiment's own versions read with its code, such as price-test 2.

number
integer | null
required

The plan's version number. Null for a version that only belongs to an experiment; an experiment version made current takes the next number.

Required range: -9007199254740991 <= x <= 9007199254740991
experiment
object | null
required

The experiment this version belongs to, if any.

isCurrent
boolean
required

Whether new buyers get this version.

parentVersionId
string | null
required

The version this one was created from.

subscriptionCount
integer
required

Active, trialing, past due and paused subscriptions on it.

Required range: -9007199254740991 <= x <= 9007199254740991
maxPlanCredits
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
maxPlanBalance
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
prices
object[]
required
createdAt
string<date-time>
required
object
string
required
Allowed value: "plan_version"
livemode
boolean
required