Update a product

put

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

Update product for your company

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyDomain

string

required

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

productID

int32

required

The unique identifier of the product in the Billsby platform

Body Params

name

string

The name of the product you want to update

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

decription

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 flase

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

productCountryLimitations

object

Set country limitations for your product

Response

200200