Saltar al contenido principal
POST
Move subscribers to a plan version
This reference describes API version 2026-06-07. Send Commet-Version: 2026-06-07 with your request.

Autorizaciones

x-api-key
string
header
requerido

Encabezados

Commet-Version
string
predeterminado:2026-06-07

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

Parámetros de ruta

id
string
requerido

Cuerpo

application/json
subscriptionIds
string[]
requerido

Public IDs of the subscriptions to move.

Required array length: 1 - 10000 elements
toVersionId
string
requerido

The version subscribers move to.

effective
enum<string>
requerido

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

Opciones disponibles:
now,
period_end
changes
object[]
requerido

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

preview
boolean
predeterminado:false
requerido

Check every subscriber without moving anyone.

Respuesta

Success

success
any
requerido
data
object
requerido