Saltar al contenido principal
POST
Change subscription version
This reference describes API version 2026-05-25. Send Commet-Version: 2026-05-25 with your request.

Autorizaciones

x-api-key
string
header
requerido

Encabezados

Commet-Version
string
predeterminado:2026-05-25

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

Parámetros de ruta

id
string
requerido

Cuerpo

application/json
planVersionId
string
requerido

A published version of the subscription's plan.

effective
enum<string>
requerido

now changes features, limits and the included credits or balance at once (the included difference is added to or subtracted from the plan credits or plan balance: an increase first pays any plan-part debt, a decrease never creates new debt, and purchased credits and purchased balance are untouched) and charges the new price from the next renewal. period_end changes everything at the next renewal. There is never a proration charge or refund.

Opciones disponibles:
now,
period_end

Respuesta

Success

success
any
requerido
data
object
requerido