Publish plan
Publishes a draft plan, making it available for use in subscriptions. The required migrationType field controls whether existing subscribers are moved onto the new version immediately (ALL_CUSTOMERS) or stay on the version they subscribed to — grandfathered — until you explicitly migrate them, e.g. via the migrate subscription endpoint (NEW_CUSTOMERS).
Authorizations
Server API Key
Headers
Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.
Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).
Path Parameters
The unique identifier of the entity
1 - 255Body
Request to publish a plan draft
Who the published version applies to: NEW_CUSTOMERS (default) leaves existing subscribers on their current version, ALL_CUSTOMERS moves them onto the new version immediately.
NEW_CUSTOMERS, ALL_CUSTOMERS Response
A task ID for tracking the async publish operation.
Response containing task ID for publish operation
Related topics
Publish PlanPlanCreate PlanSet Package PricingLaunch a trial for a paid plan with unlimited usage-based features