Saltar al contenido principal
GET
Get plan version
Get one published version of a plan with its prices and how many subscriptions are on it.

Autorizaciones

x-api-key
string
header
requerido

Encabezados

Commet-Version
string
predeterminado:2026-08-27

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

Parámetros de ruta

id
string
requerido
versionId
string
requerido

Respuesta

Success

id
string
requerido

Public plan version ID.

label
string
requerido

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
requerido

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

Rango requerido: -9007199254740991 <= x <= 9007199254740991
experiment
object | null
requerido

The experiment this version belongs to, if any.

isCurrent
boolean
requerido

Whether new buyers get this version.

parentVersionId
string | null
requerido

The version this one was created from.

subscriptionCount
integer
requerido

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

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