Preview plan change with price comparison and proration
POST
/v1/subscriptions/{subscription_id}/change_plan_preview
Preview a plan change showing price comparison and proration details.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” subscription_id
required
Subscription Id
string format: uuid
Request Body required
Section titled “Request Body required ”Responses
Section titled “ Responses ”Successful Response
ChangePlanPreviewResponse
Response for plan change preview showing comparison and proration.
object
current_plan
required
PlanSummary
Summary of a plan for comparison.
object
id
required
Id
string format: uuid
name
required
Name
string
code
required
Code
string
interval
required
Interval
string
amount_cents
required
Amount Cents
integer
currency
required
Currency
string
new_plan
required
PlanSummary
Summary of a plan for comparison.
object
id
required
Id
string format: uuid
name
required
Name
string
code
required
Code
string
interval
required
Interval
string
amount_cents
required
Amount Cents
integer
currency
required
Currency
string
effective_date
required
Effective Date
string format: date-time
proration
required
ProrationDetail
Proration calculation detail.
object
days_remaining
required
Days Remaining
integer
total_days
required
Total Days
integer
current_plan_credit_cents
required
Current Plan Credit Cents
integer
new_plan_charge_cents
required
New Plan Charge Cents
integer
net_amount_cents
required
Net Amount Cents
integer
Invalid plan or same plan
Unauthorized – invalid or missing API key
Subscription or plan not found
Validation Error
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context