GuidesAPI ReferenceSupport

List Subscription Summary

get https://secure.fusebill.com/v1/subscriptionSummary?query=field:queryString

This action will retrieve a list of summarized subscriptions. The subscriptions returned will be from a search on the entire customer base. For example, a call can be made to retrieve a list of all active subscriptions for all customers on your account. Since this will likely return a very large list, it is strongly recommended that pagination is used.

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

Parameter NameAcceptable ValuesParameter NameAcceptable Values
activatedTimestampDate RangenameString
cancellationTimestampDate RangenextBillingDateDate Range
canMigrateBooleannextPeriodStartDateDate Range
contractEndTimestampDate RangenumberOfIntervalInteger
contractStartTimestampDate RangeplanCodeString
createdTimestampDate RangeplanIdInteger
descriptionStringprovisionedTimestampDate Range
expiryDateDate RangeReferenceString
idIntegerremainingIntervalInteger
intervalMonthly, YearlyscheduledActivationTimestampDate Range
lastBillingDateDate RangescheduledMigrationDateDate Range
modifiedTimestampDate RangesubscriptionStatusActive, Draft, Cancelled, Provisioning, Expired, Migrated, Suspended, StandingOrder
MonthlyRecurringRevenueDecimal RangesuspendedTimestampDate Range
NetMonthlyRecurringRevenueDecimal Range

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/subscriptionSummary" \
	-H "Content-Type: application/json" \
	-H "Authorization: Basic {APIKey}"

//Setup API key
string apiKey = "{APIKey}";
//Configure URI
WebRequest request = WebRequest.Create("HTTPS://secure.fusebill.com/v1/subscriptionSummary");
//Add Content type
request.ContentType = "application/json";
request.ContentLength = 0;
//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/subscriptionSummary', headers=headers)
print(r.content)
Response
[ 
   { 
      "customerId":129076,
      "planCode":"onlineaccessplan",
      "name":"Online Access Plan",
      "description":null,
      "reference":"1236",
      "interval":"Monthly",
      "numberOfInterval":1,
      "subscriptionStatus":"Active",
      "monthlyRecurringRevenue":0,
      "netMonthlyRecurringRevenue":0,
      "lastBillingDate":"2016-07-09T17:00:24",
      "nextBillingDate":"2016-08-09T04:00:00",
      "expiryDate":null,
      "scheduledActivationTimestamp":null,
      "cancellationTimestamp":null,
      "suspendedTimestamp":null,
      "createdTimestamp":"2016-07-09T17:00:11",
      "modifiedTimestamp": "2019-09-29T04:01:23.73",
      "activatedTimestamp":"2016-07-09T17:00:24",
      "provisionedTimestamp":null,
      "nextPeriodStartDate":"2016-08-09T04:00:00",
      "contractStartTimestamp":null,
      "contractEndTimestamp":null,
      "remainingInterval":null,
      "id":83907,
      "uri":"https://secure.fusebill.com/v1/subscriptionsummary/83907/"
   }
]

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