Product details

Get the details of a specific product

This API returns a list of details for a specific product.

To find your product ID, navigate to the embed code page in the Billsby portal. If you scroll down on this page you'll find a lookup tool for product, plan and cycle IDs. Click on the dropdown to find the product you would like to get details on - this will be the number contained within the code given here. So if the code for your product is "Product - tiered - 273 - 0", then your product ID is 273. Alternatively, you can use the Get List products API to return a list of all products with associated IDs.

Returned Variables

Variable name

Description

isAnyCountryAllowed

This tells you whether or not you have allowed billing and shipping addresses of customer's to be from any country; true or false

countrySettings

For each country you'll see the country ISO3 code and whether or not you are giving permission from this country code; true or false

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

displayName

The display name of the product

description

The product description

typeOfProduct

The product type; tiered or multi-SKU

hasPlans

The product has plans associated with it; true or false

isShippingAddressRequired

Do you require a shipping address as well as a billing address; true or false

isShippingAddressValidationRequired

Do you require shipping address validation; true or false

isBillingAddressValidationRequired

Do you require billing address validation; true or false

isAdditionalEmailRequired

Do you require an additional email address validation; true or false

isPhoneNumberRequired

Do you require a phone number; true or false

isMarketingConsentRequired

Do you require marketing consent; true or false

numberOfPlans

The number of plans associated with this product

alertEmail

The alert email that has been set for this product

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