Saltar al contenido principal
GET
Get plan move
Read a move of subscribers between plan versions with each subscriber’s status: moving, moved, needs a change, left out, canceled or kept on its version.

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
moveId
string
requerido

Respuesta

Success

id
string | null
requerido

Public move ID. Null for a preview, which records nothing.

toVersionId
string
requerido
fromVersionIds
string[]
requerido

The versions its subscribers are moving from.

effective
enum<string>
requerido
Opciones disponibles:
now,
period_end
preview
boolean
requerido
status
enum<string>
requerido

checked is a preview where everyone fits; moving while subscribers wait for their move; completed once every move ran; canceled after it was canceled.

Opciones disponibles:
checking,
blocked,
checked,
moving,
completed,
canceled
counts
object
requerido
subscriptions
object[]
requerido
createdAt
string<date-time> | null
requerido
completedAt
string<date-time> | null
requerido
canceledAt
string<date-time> | null
requerido
object
string
requerido
Allowed value: "plan_move"
livemode
boolean
requerido