Saltar al contenido principal
POST
Archive plan experiment
This reference describes API version 2026-05-12. Send Commet-Version: 2026-05-12 with your request.

Autorizaciones

x-api-key
string
header
requerido

Encabezados

Commet-Version
string
predeterminado:2026-05-12

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.

Cuerpo

application/json
subscribers
enum<string>
predeterminado:keep
requerido

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.

Opciones disponibles:
keep,
period_end,
now
changes
object[]
requerido

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

preview
boolean
predeterminado:false
requerido

Check the archive and the move without changing anything.

Respuesta

Success

success
any
requerido
data
object
requerido