Move a pricing plan subscription to a different pricing plan within the same pricing plan group
Requires the PRICING_PLAN_SUBSCRIPTION.UPDATE or PRICING_PLAN_SCHEDULE.CREATE permission.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Headers
Request
Only allowed when the pricing plan group’s upgrade/downgrade timing policy for this transition is IMMEDIATE or IMMEDIATE_PRO_RATA; defaults to now. Not allowed when the policy is NEXT_BILLING_PERIOD.
Optionally change the billing period of the new schedule. Must be one of the target pricing plan version’s billing period settings values; if not set, the current billing period is kept.
Response
Resource ID of type PRICING_PLAN_SUBSCRIPTION
Instead of the pricing_plan_version_id, during creation, a selector can be submitted to determine the pricing plan version.
Pricing defined directly on this schedule, in addition to (or instead of) a linked pricing plan version / rate-card.
Whether this schedule is currently in effect, based on its start_at/end_at and ACTIVE status.