Skip to main content
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.

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

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

Response

Success

id
string
required

Public plan experiment ID.

code
string
required

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

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

Available options:
running,
won,
archived
startedFromVersionId
string
required

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

latestVersionId
string
required

Its latest version.

sellsVersionId
string
required

The version its code sells to new buyers today.

subscriptionCount
integer
required

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

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