You can now create plan version migrations through the API and track each one to completion. Previously, migrations could only be created in the Orb dashboard, and the API could only list and cancel them for a single plan.

• Create a migration with POST /v1/migrations, identifying the plan by plan_id or external_plan_id and the version to move to with target_plan_version_number.
• Set when it takes effect with effective_time: immediately, on a specific date, or at a term or invoice boundary.
• Migrate the subscriptions that match your filters, or pass included_subscription_ids to migrate an explicit list.
• Follow progress with GET /v1/migrations and GET /v1/migrations/{migration_id}, and check each subscription's outcome with GET /v1/migrations/{migration_id}/subscriptions.
• Cancel a migration with POST /v1/migrations/{migration_id}/cancel.

Learn more about creating migrations in our docs.