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

This query gets a list of all of the subscriptions in your account with their subscription IDs so that you can later look up individual subscriptions. It returns customer information, as well as the Plan and Product IDs.

Of the query parameters only page and pageSize are mandatory but the others will help you to narrow down and organise your results. You can order your results (e.g. CreatedOn to sort by date of creation) or only show subscriptions on a certain product or with a specified status by using the rest of the query parameters.

Subscriptions are returned in pages. The first part of the results describes which page you're on, the total number of pages, the size of the page and how many rows are in the page. Then, each result is provided within the array.

Returned variables

Variable name

Description

subscriptionId

The unique numerical identifier of the subscription.

subscriptionUniqueId

The unique alphanumerical identifier of the subscription.

customerId

The unique numerical identifier of the customer.

customerUniqueId

The unique alphanumerical identifier of the customer.

customerEmail

The customers registered email address

customerFullname

The customers full name

planId

The unique identifier of the plan in Billsby

planName

The name of the plan

productId

The unique identifier of the product in Billsby

productName

The name of the product

createdOn

The date the subscription was created on

status

The status of the subscription. This could be:

Active
InTrial
Suspended
Cancelled

isInFreeTrial

The flag that indicates whether the subscription is in free trial.

Language
Authentication
Header
Click Try It! to start a request and see the response here!