Skip to main content
POST
Cancel plan move
Cancel a move for every subscriber who has not moved yet. They stay on their version; those already moved stay moved. Commet sends subscription.version_change_canceled with reason canceled_by_merchant for each subscriber whose move is canceled.

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-08-27

API version used by this reference. Send this header to select this contract explicitly.

Path Parameters

id
string
required
moveId
string
required

Response

Success

id
string | null
required

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

toVersionId
string
required
fromVersionIds
string[]
required

The versions its subscribers are moving from.

effective
enum<string>
required
Available options:
now,
period_end
preview
boolean
required
status
enum<string>
required

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

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