Skip to main content
PATCH
Set the default version

Authorizations

Authorization
string
header
required

API key authentication

Path Parameters

id
string
required

Unique identifier for a plan

Pattern: ^plan_[a-zA-Z0-9]+$
versionNumber
integer
required

The version number within the plan (1-based).

Required range: x >= 1

Body

application/json

Sets this version as the plan's default.

default
boolean

Set to true to point the plan's default at this version. Idempotent on the already-default version.

Response

The transitioned plan version

A single plan version, including its price slots. Extends the list summary with the version's prices for draft review.

id
string
required

Unique identifier for a plan version

Pattern: ^pver_[a-zA-Z0-9]+$
object
enum<string>
required
Available options:
plan_version
versionNumber
integer
required

Monotonic version number within the plan, starting at 1.

Required range: x >= 1
status
enum<string>
required

Lifecycle status of the version.

Available options:
draft,
published,
archived
isDefault
boolean
required

Whether this version is the plan's current default (live) version.

subscriptionCount
integer
required

Number of committed-status subscriptions pinned to this version at creation time. Not a live-billing cohort.

Required range: x >= 0
updatedAt
string<date-time>
required

When this version was last modified. Optimistic-concurrency token: read this value and echo it back as an If-Match header on a draft-price-mutation request to reject the write (412) if the draft changed since this read.

prices
object[]
required

The price slots that make up this version.

publishedAt
string<date-time>

When this version was published. Absent for draft versions.

basedOnVersionId
string

The version this one follows on from — the version that was live when this one was created, and whose prices it was built from. Absent for versions created before this field existed.

Pattern: ^pver_[a-zA-Z0-9]+$