Skip to main content
POST
Preview plan change
This reference describes API version 2026-05-18. Send Commet-Version: 2026-05-18 with your request.

Authorizations

x-api-key
string
header
required

Headers

Commet-Version
string
default:2026-05-18

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

Path Parameters

id
string
required

Body

application/json
planId
string
required
Minimum string length: 1
billingInterval
enum<string>
Available options:
weekly,
monthly,
quarterly,
semiannual,
yearly,
one_time
promoCode
string

Promo code whose Offer prices the change, validated with the checkout's rules: a code the checkout would refuse returns 400 validation_error with the checkout's reason in details.reason. Cannot be combined with offerId.

Minimum string length: 1

Response

Success

success
any
required
data
object
required