List Plans

This call supports string filtering (Read More) and date range filtering (Read More)
&query=parameterName:Value

Parameter Name	Acceptable Values	Parameter Name	Acceptable Values
`autoApplyChanges`	Boolean	`modifiedTimestamp`	Date Range
`code`	String	`name`	String
`createdTimestamp`	Date Range	`reference`	String
`description`	String	`salesforceCompatible`	Boolean
`longdescription`	String	`status`	Draft, Active, Retired

This call supports pagination (Read More)
&pageSize=100&pageNumber=0
This call supports sorting (Read More)
&sortOrder=Ascending or &sortOrder=Descending
&sortExpression=expression

Examples

curl -X GET "https://secure.fusebill.com/v1/Plans/?query=status:Active" \
	-H "Content-Type: application/json" \
	-H "Authorization: Basic {APIKey}"

//query parameter
string status = "Active";
//Setup API key
string apiKey = "{APIKey}";
//Configure URI
WebRequest request = WebRequest.Create("HTTPS://secure.fusebill.com/v1/Plans/?query=status:" + status);
//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
#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/Plans/?query=status:Active', headers=headers)
print(r.content)

Response

[  
   {  
      "code":"BSC2",
      "name":"Basic",
      "reference":null,
      "description":"Basic Monthly Services for Kennedy Consulting",
      "longdescription":"this is the entry level subscription for Kennedy Consulting",
      "status":"Active",
      "modificationTimestamp":"0001-01-01T00:00:00",
      "planFrequencies":[  
         {  
            "planRevisionId":247,
            "numberOfIntervals":1,
            "interval":"Monthly",
            "numberOfSubscriptions":3,
            "status":"Active",
            "setupFees":[  
               {  
                  "amount":10.000000,
                  "currency":"USD",
                  "id":0,
                  "uri":null
               }
            ],
            "charges":[  
               {  
                  "amount":2.000000,
                  "currency":"USD",
                  "id":0,
                  "uri":null
               }
            ],
            "isProrated":false,
            "prorationGranularity":null,
            "planFrequencyUniqueId":114,
            "remainingInterval":null,
            "id":114,
            "uri":null
         }
      ],
      "autoApplyChanges":false,
      "id":114,
      "uri":"https://secure.fusebill.com/v1/Plans/114"
   }
]

{
    "ErrorId": 0,
    "HttpStatusCode": 400,
    "Errors": [
        {
            "Key": "Api Error",
            "Value": "Bad request, the query is not valid.  Please check your request and try again."
        }
    ]
}