get https://secure.fusebill.com/v1/planFamilies/bySubscription/
This endpoint allows you to retrieve available migrations for a given subscription.
Path Parameters
Property | Type | Description |
---|---|---|
SubscriptionId | Integer | The Fusebill generated ID of the Subscription |
Examples
curl -X GET "https://secure.fusebill.com/v1/planFamilies/bySubscription/{subscriptionId}"\
-H "Content-Type: application/json" \
-H "Authorization: Basic {APIKey}" \
//Json Payload
string jsonData = "{customerid:{customerId},planFamilyRelationshipId:{planFamilyRelationshipId},migrationTimingOption:'NextBillingPeriod'}}";
//Setup API key
string apiKey = "{APIKey}";
//Configure URI
WebRequest request = WebRequest.Create("https://secure.fusebill.com/v1/planFamilies/bySubscription/{subscriptionId}");
//Add Content type
request.ContentType = "application/json";
//Add Api key authorization
request.Headers.Add(HttpRequestHeader.Authorization, "Basic "+apiKey);
//Set request method
request.Method = "GET";
//Add the json data to request
using (var streamWriter = new StreamWriter(request.GetRequestStream()))
{
streamWriter.Write(jsonData);
streamWriter.Flush();
streamWriter.Close();
}
//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 requests
headers = {'Authorization' : 'Basic {API Key}', 'Content-Type' : 'application/json'}
r = requests.get('https://secure.fusebill.com/v1/planFamilies/bySubscription/{subscriptionId}', headers=headers)
print(r.content)
Response
{
"code":"upgrademigration",
"name":"Upgrade Migration",
"description":null,
"earningOption":"None",
"nameOverrideOption":"DoNotTransfer",
"descriptionOverrideOption":"DoNotTransfer",
"referenceOption":"DoNotTransfer",
"expiryOption":"DoNotTransfer",
"contractStartOption":"Transfer",
"contractEndOption":"Transfer",
"plans":[
{
"planId":828556,
"planCode":"premiumplan",
"planName":"Premium Plan",
"planFrequencies":[
{
"id":1868701,
"numberOfIntervals":1,
"interval":"Monthly"
}
],
"id":1309,
"uri":"https://secure.fusebill.com/v1/PlanFamilyPlans/1309"
}
],
"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"
}
],
"id":795,
"uri":"https://secure.fusebill.com/v1/PlanFamilies/795"
}
{
"ErrorId": 0,
"HttpStatusCode": 400,
"Errors": [
{
"Key": "subscriptionId",
"Value": "The value '1153067a1' is not valid for Int64."
}
]
}