v1
latestOpenAPI 3.1.02026-07-26580123.9 KBList products
get/{companyDomain}/products
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 number of the page you would like to return
pageSizeinteger required
The number of entries per page you would like to return
searchstring
Filter products by name (this can be a partial name)
visibilityTypeinteger
The type of visibility of each product; public, hidden and on-sale. Available values: 0, 1, 2, 3 (Public=0, Hidden=1, Internal=2, OffSale=3)
Response
200
Example response
{
"results": [
{
"name": "Product Name",
"billingCurrency": "USD",
"billingCurrencyTemplate": "$X.XX",
"displayName": "Product Name",
"description": "A description of the product",
"typeOfProduct": 1,
"hasPlans": true,
"isShippingAddressRequired": true,
"isShippingAddressValidationRequired": true,
"isBillingAddressValidationRequired": true,
"isAdditionalEmailRequired": true,
"isPhoneNumberRequired": true,
"isMarketingConsentRequired": true,
"alertEmail": "string",
"customFields": [
{
"label": "string",
"description": "string",
"options": "string",
"compulsory": true
}
]
}
]
}