Read Scheduled Migrations

This endpoint allows you to retrieve a scheduled migration for a given subscription.

Path Parameters

PropertyTypeDescription
subscriptionIdIntegerThe Fusebill generated ID that uniquely identifies the subscription
Examples
curl -X GET "https://secure.fusebill.com/v1/subscriptions/{subscriptionId}/migrate"\
-H "Content-Type: application/json" \
-H "Authorization: Basic {APIKey}"
//query parameter
int queryParameter = {subscriptionId};
//Setup API key
string apiKey = "{APIKey}";
//Configure URI
WebRequest request = WebRequest.Create("HTTPS://secure.fusebill.com/v1/subscriptions/"+queryParameter+"/migrate");
//Add Content type
request.ContentType = "application/json";
//Add Api key authorization
request.Headers.Add(HttpRequestHeader.Authorization, "Basic "+apiKey);
//Set request method
request.Method = "GET";
//Perform the request
var httpResponse = (HttpWebResponse)request.GetResponse();
//Record the response from our request
var result = "";
using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
{
  result = streamReader.ReadToEnd();
}
#Import library Requests
import requests
#Define your header parameters
headers = {'Authorization' : 'Basic {API Key}', 'Content-Type' : 'application/json'}
#Pass in your URI and Headers
r = requests.get('https://secure.fusebill.com/v1/subscriptions/{subscriptionId}/migrate', headers=headers)
print(r.content)
Response
{
   "customerId":12356,
   "planFamilyId":795,
   "planFamilyRelationshipId":1616,
   "planFrequencyId":1868701,
   "earningOption":"FamilyDefault",
   "nameOverrideOption":"FamilyDefault",
   "descriptionOverrideOption":"FamilyDefault",
   "referenceOption":"FamilyDefault",
   "expiryOption":"FamilyDefault",
   "contractStartOption":"FamilyDefault",
   "contractEndOption":"FamilyDefault",
   "planFamilyRelationship":{
      "planFamilyId":795,
      "relationshipMigrationType":"Upgrade",
      "sourceLabel":"Basic Plan (basicplan) / Every 1 month",
      "sourcePlanId":0,
      "sourcePlanFrequencyId":1868700,
      "sourcePlan":null,
      "sourcePlanFrequency":null,
      "destinationLabel":"Premium Plan (premiumplan) / Every 1 month",
      "destinationPlanId":828556,
      "destinationPlanFrequencyId":1868701,
      "destinationPlan":{
         "code":"premiumplan",
         "name":"Premium Plan",
         "reference":null,
         "description":null,
         "longdescription":null,
         "status":"Active",
         "modificationTimestamp":"0001-01-01T00:00:00",
         "planFrequencies":[
            {
               "planRevisionId":1108336,
               "numberOfIntervals":1,
               "interval":"Monthly",
               "numberOfSubscriptions":0,
               "status":"Active",
               "setupFees":[

               ],
               "charges":[

               ],
               "isProrated":false,
               "prorationGranularity":null,
               "planFrequencyUniqueId":1283935,
               "remainingInterval":null,
               "id":1868701,
               "uri":null
            }
         ],
         "autoApplyChanges":false,
         "id":828556,
         "uri":"https://secure.fusebill.com/v1/Plans/828556"
      },
      "destinationPlanFrequency":{
         "numberOfIntervals":1,
         "interval":"Monthly"
      },
      "earningOption":"Unearned",
      "nameOverrideOption":"FamilyDefault",
      "descriptionOverrideOption":"FamilyDefault",
      "referenceOption":"FamilyDefault",
      "expiryOption":"FamilyDefault",
      "contractStartOption":"FamilyDefault",
      "contractEndOption":"FamilyDefault",
      "availableOnSsp":false,
      "id":1616,
      "uri":"https://secure.fusebill.com/v1/PlanFamilyRelationships/1616"
   },
   "planFamily":{
      "code":"upgrademigration",
      "name":"Upgrade Migration",
      "description":null,
      "earningOption":"None",
      "nameOverrideOption":"DoNotTransfer",
      "descriptionOverrideOption":"DoNotTransfer",
      "referenceOption":"DoNotTransfer",
      "expiryOption":"DoNotTransfer",
      "contractStartOption":"Transfer",
      "contractEndOption":"Transfer",
      "id":795,
      "uri":"https://secure.fusebill.com/v1/PlanFamilies/795"
   },
   "migrationTimingOption":"SpecificDate",
   "scheduledMigrationDate":"2017-05-25T04:00:00",
   "id":3135694,
   "uri":"https://secure.fusebill.com/v1/Subscriptions/3135694/Migrate"
}
null
{
    "ErrorId": 0,
    "HttpStatusCode": 404,
    "Errors": [
        {
            "Key": "Api Error",
            "Value": "Subscription with id 123456 not found."
        }
    ]
}
Language
Authorization