Supersede plan

If you want to update a plan's amount and information, and the update has a significant effect on subscriptions, you must supersede the old plan. This means Billwerk+Optimize will create a new version of the plan.
Superseding creates a new version and allows you to configure what should happen to the subscriptions on this plan. There are two options available for the supersede_mode parameter:

• no_sub_update: This option will not update the subscriptions already on the current plan, but the new version will apply to new subscriptions.
• scheduled_sub_update: This option will update the subscriptions already on the current plan and will apply the new version to new subscriptions.

Be aware that subscription changes take place at the time of renewal — in other words, at the beginning of the next billing period.

If you want to change a subscription immediately, you can use the Change subscription endpoint.

There may be cases where you want to supersede a plan and apply the new version to all subscriptions, but keep a few subscriptions on the old version.
In this case, use the scheduled_sub_update mode, and afterward, cancel the scheduled changes for the subscriptions you want to keep on the old version
by using Change subscription with the cancel_change parameter set to true.

Errors

The operation can generate the following errors beside the generic HTTP error codes described here.