Authorizations
Enter your API key in the format x-api-key <api-key>*
Path Parameters
Subscription ID
Body
application/json
Subscription change preview request
Request object for changing a subscription plan (upgrade/downgrade)
Available options:
RECURRING
, ONETIME
Available options:
anniversary
, calendar
Available options:
MONTHLY
, ANNUAL
, WEEKLY
, DAILY
, QUARTERLY
, HALF_YEARLY
billing_period_count is the billing period count for the new subscription
Available options:
create_prorations
, none
target_plan_id is the ID of the new plan to change to (required)
metadata contains additional key-value pairs for storing extra information
Response
OK
Response showing the financial impact of a subscription plan change
Available options:
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