---
title: "Preview migration"
method: POST
path: "/plan-version-migrations/preview"
tags: ["planmigrations"]
---

# Preview migration

`POST /plan-version-migrations/preview`

## Request body

- PreviewMigrationRequestBody
  - `company_ids` string[]
  - `plan_id` string, required
  - `plan_version_id_to` string, required
  - `plan_version_ids_from` string[]
  - `target_plan_type` 'plan' | 'add_on', required

## Response `200`

OK

- object
  - `data` PlanVersionMigrationPreviewResponseData, required
    - `companies` PlanVersionMigrationPreviewCompanyResponseData[], required
      - `company_id` string, required
      - `has_billing_changes` boolean, required
      - `has_custom_pricing` boolean, required
      - `note` string, nullable
      - `plan_version_id_from` string, nullable
      - `will_update_subscription` boolean, required
      - `would_fail` boolean, required
    - `has_billing_changes` boolean, required
  - `params` object, required — Input parameters

## Other responses

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

## Changes

- **2026-08-18** `ff85db3452b4` — 1 info
  - added the required property `data/companies/items/would_fail` to the response with the `200` status
- **2026-08-11** `a1d33706a142` — 2 info
  - the request property `company_ids` became optional
  - the request property `plan_version_ids_from` became optional
- **2026-08-10** `8b0d50574230` — 1 breaking, 1 info
  - added the new required request property `plan_version_ids_from`
  - added the required property `data/has_billing_changes` to the response with the `200` status
- **2026-07-24** `23e3fa0734c3` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/schematichq/apis/schematic-api/changes/plan-version-migrations/preview/post.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-service-production.skmtc.workers.dev/v1/apis/schematichq/schematic-api/revisions/0b238e148fa1/schema)