v1

latestOpenAPI 3.1.02026-07-26580123.9 KB

List subscriptions

This query gets a list of all of the subscriptions in your account with their subscription IDs so that you can later lookup individual subscriptions

get/{companyDomain}/subscriptions

Path parameters

companyDomainstring required

Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets

Query parameters

pageinteger required

The page of customers you would like to view

pageSizeinteger required

The number of records to return per page

orderBystring

You can order the subscriptions by any of the subscription object properties (e.g. CreatedOn to sort by date of creation)

orderByDescendingstring

The ordering direction of the previously set property (e.g. Descending in CreatedOn will sort from newest to oldest, non-descending from oldest to newest)

isActiveboolean

Will show only the subscriptions that are active

isInFreeTrialboolean

Will show only the subscriptions that are in free trial

productNamestring

Will show only the subscriptions that has products whose names matches the value provided here

planNamestring

Will show only the subscriptions that has plans whose names matches the value provided here

Response

200

currentPageinteger

pageCountinteger

pageSizeinteger

rowCountinteger

Example response

{
  "results": [
    {
      "subscriptionId": 10,
      "subscriptionUniqueID": "GAFD660",
      "customerId": 10,
      "customerUniqueId": "VKQRJFLZNV",
      "customerEmail": "maryf@mistimail.com",
      "customerFullname": "Mary",
      "planId": "82",
      "planName": "Premium",
      "productId": "44",
      "productName": "Plus",
      "createdOn": "2019-08-29T09:40:27.590Z",
      "status": "Active"
    }
  ]
}