planmigrations

Create migration

Changed on
post/plan-version-migrations

Request

  • Base URL
    https://api.schematichq.com
  • URL
    https://api.schematichq.com/plan-version-migrations
  • Auth
    API key in header X-Schematic-Api-Key

Request body

company_idsstring[]
excluded_company_idsstring[]
plan_idstring required
plan_version_id_tostring required
plan_version_ids_fromstring[]
proration_behavior'always_invoice' | 'create_prorations' | 'none'
scheduled_atstring date-time nullable

When every company moves, for strategy scheduled. Must be in the future; the migration runs within about a minute of this time. Not accepted with other strategies.

strategy'end_of_billing_period' | 'immediate' | 'leave' | 'scheduled' required
target_plan_type'plan' | 'add_on' required

Response

Created

paramsobject required

Input parameters

Changes

  • af5a1afcf7ffRevision changes
    • warning

      added the new scheduled enum value to the / response property for the response status

    • info

      added the new optional request property

    • info

      added the new scheduled enum value to the request property

    • info

      added the optional property / to the response with the status

  • 1b35e4327220Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status