Read Plan Family

This call retrieves a specific plan family by the Fusebill generated ID

Path Parameters

PropertyTypeDescription
planFamilyIDIntegerThe Fusebill generated plan family ID for the plan family being requested
Examples
curl –X GET https://secure.fusebill.com/v1/PlanFamilies/{planFamilyID} \ 
-H "Content-Type: application/json" \ 
-H "Authorization: Basic {APIKey}"
//query parameter 
Int planFamilyID= {planFamilyID}; 
//Setup API key 
string apiKey = "{APIKey}"; 
//Configure URI 
WebRequest request = WebRequest.Create("HTTPS://secure.fusebill.com/v1/PlanFamilies/" + planFamilyID); 
//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 JSON 
import json 
#Import library Requests 
import requests 
#Pass in a dictionary to the Headers parameter 
headers = {'Authorization' : 'Basic {APIKey}', 'Content-Type' : 'application/json'} 
#Pass in your URI and Headers 
r = requests.get('https://secure.fusebill.com/v1/PlanFamilies/{planFamilyID}',  headers=headers) 
print(r.content)
Response
[
  {
    "code": "ScreenPlans",
    "name": "Screen Plans",
    "description": null,
    "earningOption": "None",
    "nameOverrideOption": "Transfer",
    "descriptionOverrideOption": "Transfer",
    "referenceOption": "Transfer",
    "expiryOption": "Transfer",
    "customFieldsOption": "Transfer",
    "contractStartOption": "Transfer",
    "contractEndOption": "Transfer",
    "plans": [
      {
        "planId": 56789,
        "planCode": "bronze",
        "planName": "Bronze",
        "planFrequencies": [
          {
            "id": 21457971,
            "numberOfIntervals": 1,
            "interval": "Monthly"
          }
        ],
        "id": 241591,
        "uri": "https://secure.fusebill.com/v1/PlanFamilyPlans/56789"
      },
      {
        "planId": 55131,
        "planCode": "silver",
        "planName": "silver",
        "planFrequencies": [
          {
            "id": 21457972,
            "numberOfIntervals": 1,
            "interval": "Monthly"
          }
        ],
        "id": 241592,
        "uri": "https://secure.fusebill.com/v1/PlanFamilyPlans/55131"
      }
    ],
    "planFamilyRelationship": [
      {
        "planFamilyId": 165738,
        "relationshipMigrationType": "PlanUpdate",
        "sourceLabel": "Bronze (bronze) / Every 1 month",
        "sourcePlanId": 9130471,
        "sourcePlanFrequencyId": 21457971,
        "sourcePlan": {
          "code": "bronze",
          "name": "Bronze",
          "reference": null,
          "description": null,
          "longdescription": null,
          "status": "Active",
          "modificationTimestamp": "0001-01-01T00:00:00",
          "planFrequencies": [
            {
              "planRevisionId": 11516707,
              "numberOfIntervals": 1,
              "interval": "Monthly",
              "numberOfSubscriptions": 6,
              "status": "Active",
              "setupFees": [],
              "charges": [],
              "isProrated": false,
              "prorationGranularity": null,
              "planFrequencyUniqueId": 14940588,
              "remainingInterval": 3,
              "invoiceInAdvance": 0,
              "salesforceId": null,
              "id": 21457971,
              "uri": null
            }
          ],
          "autoApplyChanges": false,
          "salesforceCompatible": true,
          "id": 558491,
          "uri": "https://secure.fusebill.com/v1/Plans/558491"
        },
        "sourcePlanFrequency": {
          "numberOfIntervals": 1,
          "interval": "Monthly"
        },
        "destinationLabel": "silver (silver) / Every 1 month",
        "destinationPlanId": 9130472,
        "destinationPlanFrequencyId": 21457972,
        "destinationPlan": {
          "code": "silver",
          "name": "silver",
          "reference": null,
          "description": null,
          "longdescription": null,
          "status": "Active",
          "modificationTimestamp": "0001-01-01T00:00:00",
          "planFrequencies": [
            {
              "planRevisionId": 11516708,
              "numberOfIntervals": 1,
              "interval": "Monthly",
              "numberOfSubscriptions": 0,
              "status": "Active",
              "setupFees": [],
              "charges": [],
              "isProrated": false,
              "prorationGranularity": null,
              "planFrequencyUniqueId": 14940589,
              "remainingInterval": null,
              "invoiceInAdvance": 0,
              "salesforceId": null,
              "id": 21457972,
              "uri": null
            }
          ],
          "autoApplyChanges": false,
          "salesforceCompatible": true,
          "id": 9130472,
          "uri": "https://secure.fusebill.com/v1/Plans/9130472"
        },
        "destinationPlanFrequency": {
          "numberOfIntervals": 1,
          "interval": "Monthly"
        },
        "earningOption": "None",
        "nameOverrideOption": "FamilyDefault",
        "descriptionOverrideOption": "FamilyDefault",
        "referenceOption": "FamilyDefault",
        "customFieldsOption": "FamilyDefault",
        "expiryOption": "FamilyDefault",
        "contractStartOption": "FamilyDefault",
        "contractEndOption": "FamilyDefault",
        "availableOnSsp": false,
        "sspConfiguration": null,
        "managedRelationship": null,
        "planFamilyRelationshipMapping": [
          {
            "sourcePlanProduct": {
              "status": "Active",
              "productId": 22928411,
              "productCode": "screen access",
              "productName": "screen access",
              "productDescription": null,
              "planProductUniqueId": 16617184,
              "id": 22154944,
              "uri": null
            },
            "destinationPlanProduct": {
              "status": "Active",
              "productId": 22928411,
              "productCode": "screen access",
              "productName": "screen access",
              "productDescription": null,
              "planProductUniqueId": 16617185,
              "id": 22154945,
              "uri": null
            },
            "sourcePlanProductId": 22154944,
            "destinationPlanProductId": 22154945,
            "nameOverrideOption": "Transfer",
            "descriptionOverrideOption": "Transfer",
            "quantityOption": "Transfer",
            "inclusionOption": "UseCatalogSetting",
            "upliftOption": "Transfer",
            "discountOption": "Transfer",
            "expiryOption": "Transfer",
            "scheduledDateOption": "Transfer",
            "customFieldsOption": "Transfer",
            "id": 84710,
            "uri": null
          }
        ],
        "id": 312305,
        "uri": "https://secure.fusebill.com/v1/PlanFamilyRelationships/312305"
      }
    ],
    "id": 165738,
    "uri": "https://secure.fusebill.com/v1/PlanFamilies/165738"
  }
]
{
    "ErrorId": 0,
    "HttpStatusCode": 500,
    "Errors": [
        {
            "Key": "Api Error",
            "Value": "Sequence contains no elements"
        }
    ]
}
Language
Authorization