Skip to main content
POST
Archive plan experiment
This reference describes API version 2026-07-24. Send Commet-Version: 2026-07-24 with your request.

Authorizations

x-api-key
string
header
required

Headers

Idempotency-Key
string

Unique key used to safely retry this write for 24 hours without applying it twice.

Required string length: 1 - 200
Commet-Version
string
default:2026-07-24

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.

Body

application/json
subscribers
enum<string>
default:keep

What happens to the experiment's subscribers: keep them on its versions, move them to the plan's current version at their next renewal, or move them now. Nobody moves, and the experiment keeps running, unless every one of them fits or has a change.

Available options:
keep,
period_end,
now
changes
object[]

Per-subscriber changes that make each one fit, applied at its renewal.

preview
boolean
default:false

Check the archive and the move without changing anything.

Response

Success

experiment
object
required
moveId
string | null
required

The move of its subscribers, or null when they stay.

object
string
required
Allowed value: "plan_experiment_archive"
livemode
boolean
required