Create a product

post

https://public.billsby.com/api/v1/rest/core/{companyDomain}/products

Create a new product for your company

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This query allows you to create a product without using the products interface on the Billsby application. You are able to define all settings associated with the product that you would be able to within the Billsby application.

Returned variables

Variable name	Description
ProductCountryLimitation
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

Path Params

companyDomain

string

required

Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets

Body Params

name

string

The internal name of the product you want to create

visibility

int32

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)

billingCurrency

string

The currency you want to the product to be billed in. This must be an ISO3 currency code with maximum three characters. For example: GBP, USD, etc.

displayName

string

The display name of the product you want to create

description

string

A short description of the product

isShippingAddressRequired

boolean

Do you need to collect a shipping address from your customers for this product; true or false

isShippingAddressValidationRequired

boolean

Do you want to validate the shipping address using our tool; true or false

isBillingAddressValidationRequired

boolean

Do you want to validate the billing address using our tool; true or false

isAdditionalEmailRequired

boolean

Do you want to collect an additional email address from your customers at checkout; true or false

isPhoneNumberRequired

boolean

Do you need to collect a phone number from your customers at checkout; true or false

is MarketingConsentRequired

boolean

Do you need to get marketing consent from your customers at checkout; true or false

alertEmail

string

Set an email to be alerted when a customer signs up for this product

orderedCustomFields

object

Add any custom fields you've created to your checkout flow for this product by adding the custom fields IDs

typeOfProduct

int32

The type of product you want to create; 1 is tiered

productCountryLimitation

object

Set country limitations for your product

isAnyCountryAllowed

boolean

Do you want to allow any country allowed access to the product; true or false

Response

Returned variables

200200