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 name | Description |
|---|---|
| productId | The unique identifier of the product in the Billsby platform |
| name | The name of the product |
| visibility | The visibility you have defined for your product; public, hidden, internal or off-sale |
| billingCurrency | The billing currency of the product |
| billingCurrencyTemplate | |
| displayName | The display name of the product |
| description | The product description |
| typeOfProduct | The product type: 1 - Tiered 2- Multi-SKU |
| hasPlans | The product has plans associated with it: True False |
| isShippingAddressRequired | Does the product require customers to have a shipping address: True False |
| isShippingAddressValidationRequired | Does the product require that the shipping address is validated when it is added through Billsby Checkout: True False |
| isBillingAddressValidationRequired | Does the product require that the billing address is validated when it is added through Billsby Checkout: True False |
| isAdditionalEmailRequired | Does the product request an additional billing email address from the customer when it is added through Billsby Checkout: True False |
| isPhoneNumberRequired | Does the product request a phone number from the customer when it is added through Billsby Checkout: True False |
| isMarketingConsentRequired | Does the product request marketing consent from the customer when it is added through Billsby Checkout: True False |
| numberOfPlans | The number of plans associated with the product expressed as an integer |
| alertEmail | The alert email address that has been set for email forwarding relating to this product |
Custom fields
| Variable name | Description |
|---|---|
| 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.