Skip to main content
POST
Change subscription version
This reference describes API version 2026-06-23. Send Commet-Version: 2026-06-23 with your request.

Authorizations

x-api-key
string
header
required

Headers

Commet-Version
string
default:2026-06-23

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

Path Parameters

id
string
required

Body

application/json
planVersionId
string
required

A published version of the subscription's plan.

effective
enum<string>
required

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.

Available options:
now,
period_end

Response

Success

success
any
required
data
object
required