Skip to main content
PATCH
Update 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
prices
object[]

Every interval the draft sells. An interval the draft sold and this list leaves out is removed from the draft.

countries
object[]

Every country with its own currency or prices. A country the draft sold and this list leaves out is removed. A country missing a price blocks publishing.

rules
object

Credit or balance rules; fields left out stay as they are.

undo
string[]

Change keys to put back as the version the draft started from had them.

Response

Success

id
string
required

Public plan draft ID.

fromVersionId
string
required

The version the draft started from.

changes
object[]
required

What the draft changes against the version it started from.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
object
string
required
Allowed value: "plan_draft"
livemode
boolean
required