List products

This API returns a list of all of the products in your account and provides information about the requirements and custom fields associated with the products. It doesn't return pricing information as this sits in the plan and cycle elements, but it does retrieve the product IDs, which you can then use to get plan and cycle information in separate calls.

You can filter the results from this API by either name (full or partial) or visibility. This is useful if you want to provide search functionality or only show publicly available products in a specific view.

Products 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 nameDescription
productIdThe unique identifier of the product in the Billsby platform
nameThe name of the product
visibilityThe visibility you have defined for your product; public, hidden, internal or off-sale
billingCurrencyThe billing currency of the product
billingCurrencyTemplate
displayNameThe display name of the product
descriptionThe product description
typeOfProductThe product type:

1 - Tiered
2- Multi-SKU
hasPlansThe product has plans associated with it:

True
False
isShippingAddressRequiredDoes the product require customers to have a shipping address:

True
False
isShippingAddressValidationRequiredDoes the product require that the shipping address is validated when it is added through Billsby Checkout:

True
False
isBillingAddressValidationRequiredDoes the product require that the billing address is validated when it is added through Billsby Checkout:

True
False
isAdditionalEmailRequiredDoes the product request an additional billing email address from the customer when it is added through Billsby Checkout:

True
False
isPhoneNumberRequiredDoes the product request a phone number from the customer when it is added through Billsby Checkout:

True
False
isMarketingConsentRequiredDoes the product request marketing consent from the customer when it is added through Billsby Checkout:

True
False
numberOfPlansThe number of plans associated with the product expressed as an integer
alertEmailThe alert email address that has been set for email forwarding relating to this product

Custom fields

Variable nameDescription
customFieldID
type
label
description
options
compulsory

Custom field order

Returns the order that custom fields are displayed to the customer when they checkout this product in Billsby Checkout. The order is returned as a comma seperated list.

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