Move subscribers to a plan version
Move a list of subscriptions, or every subscription of another version, to a newer version of the plan, at their next renewal or now. Nobody moves unless every one of them fits or has a change in changes; otherwise the response lists each one with what would make it fit. Subscriptions whose status does not allow a move, such as paused ones, and one-time subscriptions in a move at renewal are left out. A move keeps each subscription’s currency, and a free version moves only to a free version and a paid one only to a paid version. Send preview to check without moving anyone.
202 with the move. Follow it and each subscriber’s status with Get plan move. subscription.version_changed fires for each subscription when its move takes effect.Authorizations
Headers
Unique key used to safely retry this write for 24 hours without applying it twice.
1 - 200API version used by this reference. Send this header to select this contract explicitly.
Path Parameters
Body
- Option 1
- Option 2
Public IDs of the subscriptions to move.
1 - 10000 elementsThe version subscribers move to.
now changes features and the included amount today and the price at renewal; period_end moves each subscriber at its next renewal.
now, period_end Per-subscriber changes that make each one fit, applied at its renewal.
Check every subscriber without moving anyone.
Response
Success
Public move ID. Null for a preview, which records nothing.
The versions its subscribers are moving from.
now, period_end checked is a preview where everyone fits; moving while subscribers wait for their move; completed once every move ran; canceled after it was canceled.
checking, blocked, checked, moving, completed, canceled "plan_move"