Skip to content

Migrate a subscription to a new plan

POST
/subscription/migration
billing.funnelfox.com

Switch an active subscription to a different Price Point (plan).

org_id
required
string

Organization ID

Media typeapplication/json
MigrationIn
object
reason
Reason

Short reason code (e.g., “duplicate_payment”, “unauthorized_charge”)

string
"" · ≤ 256 characters
comment
Comment

Human-readable comment or reference (e.g., support ticket link)

string
"" · ≤ 2048 characters
external_id
Customer Id

Your unique identifier for the user

string
nullable · ≤ 256 characters
subs_id
required
Subs Id
string format: uuid
pp_ident
required
price point ident

Unique identifier of the price point

string
≤ 256 characters · /^[-A-Za-z_0-9]{1,256}$/
strategy
MigrationStrategy
string
default: price_prorate
one of price_prorate delayed_start
dry_run
Dry Run
boolean
strict_mode
Strict Mode
boolean
default: true
Media typeapplication/json
MigrationOut
object
payment_result
Any of:
CheckoutMigrationPaymentOut
Show 3 propertiesHide properties
checkout_status
required
CheckoutPaymentStatus
string
one of processing succeeded failed cancelled
failed_message_for_user
required
Failed Message For User
string
order_id
required
string format: uuid
nullable
charged_amount
Any of:
number
subs_id
string format: uuid
nullable
oneoff_id
string format: uuid
nullable
migration_strategy
required
MigrationStrategy
string
one of price_prorate delayed_start