Skip to main content
POST
Publish plan draft
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
draftId
string
required

Body

application/json
publishAs
string
required

current sells the draft to every new buyer.

Allowed value: "current"
move
enum<string>
default:keep

What happens to subscribers of earlier versions: keep them, move them at their next renewal, or move them now (features and balance change today, the price at renewal). Nobody moves unless every one of them fits or has a change below.

Available options:
keep,
period_end,
now
changes
object[]

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

preview
boolean
default:false

Check everything without publishing.

Response

Success

preview
boolean
required
version
object | null
required

The published version. Null for a preview.

moveId
string | null
required

The move of subscribers, if any.

subscribers
object | null
required
object
string
required
Allowed value: "plan_draft_publication"
livemode
boolean
required