GuidesAPI ReferenceSupport
API Reference

Create Migration

post
https://secure.fusebill.com/v1/subscriptions//migrate

This endpoint allows you to migrate a customer's subscription to a new plan type as defined in your plan family configuration. The migration action can be scheduled with this call to occur at a specified time in the future, or it can be done immediately.

Path Params
int32
required

The Fusebill generated ID of the subscription intended to migrate.

Body Params
int32
required

The Fusebill generated ID of the customer who owns the subscription to be migrated

int32
required

The Fusebill generated ID of the plan family relationship being used to define the rules of the migration

string
enum
required

Controls the timing of the migration. "Now" immediately migrates the subscription, whereas the other options schedule the migration to occur in the future.

Allowed:
boolean

Controls the timing of the migration. "Now" immediately migrates the subscription, whereas the other options schedule the migration to occur in the future.

boolean

This will specify whether or not the resulting invoice from this call will post the related invoice or not

string
enum

Controls how to handle the financials of the source subscription. Charges can be fully earned, the unearned charges can be reversed, or all the charges can be reversed.

Allowed:
string
enum

Controls whether the name is transferred from the source subscription to the destination.

Allowed:
string
enum

Controls whether the custom fields are transferred from the source subscription to the destination.

Allowed:
string
enum

Controls whether the subscription reference is transferred from the source subscription to the destination

Allowed:
string
enum

Controls whether the expiry progression is transferred from the source subscription to the destination

Allowed:
string
enum

Controls whether the name is transferred from the source subscription to the destination.

Allowed:
string
enum

Controls whether the contract start information is transferred from the source subscription to the destination

Allowed:
string
enum

Controls whether the contract end information is transferred from the source subscription to the destination

Allowed:
date

The scheduled time for this migration to occur.

string

The coupon code attached to the subscription migration.

Responses

Updated about 1 year ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 year ago