List Subscriptions

Query, paginate, and sort subscription list results.

Query String Parameters

This call supports querying, pagination, and sorting. For syntax and examples, see Pagination, Filtering, Sorting, and Event Suppression.
&query=parameterName:Value

Parameter NameAcceptable ValuesParameter NameAcceptable Values
AmountDecimal RangeCustomer.ReferenceString
BillingPeriodDefinition.IdIntegerCustomer.SalesforceIdString
contractEndTimestampDate RangeCustomer.StatusDraft, Active, Cancelled, Hold, Suspended
contractStartTimestampDate RangeexpiredTimestampDate Range
createdTimestampDate RangeintervalMonthly, Yearly
CurrentMrrDecimal RangeinvoiceDayInteger (1-31)
CurrentNetMrrDecimal RangemodifiedTimestampDate Range
Customer.AccountStatusGood, PoorStanding, CollectionMonthlyRecurringRevenueDecimal Range
Customer.ArbalanceDecimal RangeNetMRRDecimal Range
Customer.CompanyNameStringplanCodeString
Customer.CreatedTimestampDate RangeplanDescriptionString
Customer.CurrencyIdInteger (1-24)*planNameString
Customer.CurrentMrrDecimal RangeplanReferenceString
Customer.CurrentNetMrrDecimal RangeprovisionedTimestampDate Range
Customer.CustomerReference.Reference1StringreferenceString
Customer.CustomerReference.Reference2StringremainingIntervalInteger
Customer.CustomerReference.Reference3StringremainingIntervalPushOutInteger
Customer.FirstNameStringsalesForceIdString
Customer.LastNameStringscheduledActivationTimestampDate Range
Customer.MiddleNameStringScheduledMigration.PlanFamilyIdInteger
Customer.ModifiedTimestampDate RangeScheduledMigration.PlanFamilyRelationshipIdInteger
Customer.MonthlyRecurringRevenueDecimal RangeScheduledMigration.PlanFrequencyIdInteger
Customer.NetMRRDecimal RangeScheduledMigration.SpecifiedDateDate Range
Customer.NetSuiteIdStringstatusActive, Draft, Cancelled, Migrated, Provisioning, Expired, Suspended, StandingOrder
Customer.ParentIdIntegerSubscriptionOverride.DescriptionString
Customer.QuickBooksIdIntegerSubscriptionOverride.NameString
Customer.IdInteger

* See here for Fusebill currency codes
Use &pageSize=100&pageNumber=0 for pagination.
Use &sortOrder=Ascending or &sortOrder=Descending with &sortExpression=expression for sorting.

Query Params
string
boolean

Reduces the included subscription products to only show any that are uncluded=true, and does not return any that are included=false. That is, it will only return any subscription products that are set to be invoiced (while the subscrpition status is active).

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json