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

Authorizations

x-api-key
string
header
required

Headers

Idempotency-Key
string

Unique key used to safely retry this write for 24 hours without applying it twice.

Required string length: 1 - 200
Commet-Version
string
default:2026-07-31

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
offerId
string
Minimum string length: 1
promoCode
any

Response

Success

currency
string
required
currentPlanCredit
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
newPlanCharge
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
estimatedTotal
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
effectiveDate
string<date-time>
required
daysRemaining
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
totalDays
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
isUpgrade
boolean
required
deactivatedAddons
object[]
required

Active add-ons that the version the change moves the subscription to does not sell. The change deactivates them when it applies.

object
string
required
Allowed value: "plan_change_preview"
livemode
boolean
required
offerApplication
object