Skip to main content
POST
Move subscribers to a plan version
This reference describes API version 2026-06-10. Send Commet-Version: 2026-06-10 with your request.

Authorizations

x-api-key
string
header
required

Headers

Commet-Version
string
default:2026-06-10

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

Path Parameters

id
string
required

Body

application/json
subscriptionIds
string[]
required

Public IDs of the subscriptions to move.

Required array length: 1 - 10000 elements
toVersionId
string
required

The version subscribers move to.

effective
enum<string>
required

now changes features and the included amount today and the price at renewal; period_end moves each subscriber at its next renewal.

Available options:
now,
period_end
changes
object[]
required

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

preview
boolean
default:false
required

Check every subscriber without moving anyone.

Response

Success

success
any
required
data
object
required