Saltar al contenido principal
GET
Get plan experiment
Get one experiment of a plan by its own code, with the version it sells 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
code
string
requerido

The experiment's own code, without the plan code: price-test.

Respuesta

Success

id
string
requerido

Public plan experiment ID.

code
string
requerido

The code to sell it with as planCode, such as pro:price-test. It always sells the experiment's latest version while running, and the plan's current version once closed.

status
enum<string>
requerido

running sells its latest version; won became the plan's current version; archived stopped selling.

Opciones disponibles:
running,
won,
archived
startedFromVersionId
string
requerido

The plan's version that was current when it started.

latestVersionId
string
requerido

Its latest version.

sellsVersionId
string
requerido

The version its code sells to new buyers today.

subscriptionCount
integer
requerido

Active, trialing, past due and paused subscriptions on its versions.

Rango requerido: -9007199254740991 <= x <= 9007199254740991
createdAt
string<date-time>
requerido
closedAt
string<date-time> | null
requerido
object
string
requerido
Allowed value: "plan_experiment"
livemode
boolean
requerido