Preview the impact of changing a subscription’s plan, including proration calculations
Enter your API key in the format x-api-key <api-key>*
Subscription ID
Subscription change preview request
Request object for changing a subscription plan (upgrade/downgrade)
RECURRING, ONETIME anniversary, calendar MONTHLY, ANNUAL, WEEKLY, DAILY, QUARTERLY, HALF_YEARLY create_prorations, none target_plan_id is the ID of the new plan to change to (required)
billing_period_count is the billing period count for the new subscription
immediate, end_of_period metadata contains additional key-value pairs for storing extra information
OK
Response showing the financial impact of a subscription plan change
upgrade, downgrade, lateral effective_date is when the change would take effect
metadata from the request
subscription_id is the ID of the subscription being changed
warnings contains any warnings about the change