---
title: "Publish plan version"
method: PUT
path: "/plans/version/{plan_id}/publish"
tags: ["plans"]
---

# Publish plan version

`PUT /plans/version/{plan_id}/publish`

## Path parameters

- `plan_id` string, required

## Request body

- PublishPlanVersionRequestBody
  - `activation_strategy` 'on_payment' | 'on_publish'
  - `coupon_external_id` string, nullable
  - `customer_email` string, nullable
  - `days_until_due` integer, nullable
  - `excluded_company_ids` string[], required
  - `migration_strategy` 'immediate' | 'leave', required

## Response `200`

OK

- object
  - `data` PlanVersionResponseData, required
    - `created_at` string, date-time, required
    - `description` string, required
    - `environment_id` string, required
    - `icon` 'amber' | 'blue' | 'blueGray' | 'blueGreen' | 'cyan' | 'emerald' | 'fuchsia' | 'gray' | 'green' | 'indigo' | 'lightBlue' | 'lime' | 'orange' | 'pink' | 'purple' | 'red' | 'redOrange' | 'rose' | 'sky' | 'slate' | 'teal' | 'trueGray' | 'violet' | 'warmGray' | 'yellow', required
    - `id` string, required
    - `name` string, required
    - `original_plan_id` string, nullable
    - `plan_type` 'plan' | 'add_on', required
    - `status` 'published' | 'draft' | 'archived', required
    - `updated_at` string, date-time, required
    - `version` integer, required
  - `params` object, required — Input parameters

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `500` — Server error

## Changes

- **2026-06-23** `283b59d13ce9` — 1 info
  - added the new optional request property `coupon_external_id`
- **2026-06-16** `62be4a7ae183` — 1 warning
  - removed the request property `pay_in_advance`
- **2026-05-26** `b6a1655e4d80` — 1 info
  - request property `pay_in_advance` deprecated

[Change history](https://skmtc.dev/schematichq/apis/schematic-api/changes/plans/version/:plan_id/publish/put.md)

---

[API](https://skmtc.dev/schematichq/apis/schematic-api.md) · [All operations](https://skmtc.dev/schematichq/apis/schematic-api/llms.txt) · [OpenAPI document](https://skmtc.dev/schematichq/apis/schematic-api/revisions/ae246bb663d6?raw)
