v1

latestOpenAPI 3.1.02026-07-26580123.9 KB

Update a product

Update product for your company

put/{companyDomain}/products/{productId}

Path parameters

companyDomainstring required

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

productIDinteger required

The unique identifier of the product in the Billsby platform

Request body

namestring

The name of the product you want to update

visibilityinteger

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)

billingCurrencystring

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

displayNamestring

The display name of the product you want to create

decriptionstring

A short description of the product

isShippingAddressRequiredboolean

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

isShippingAddressValidationRequiredboolean

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

isBillingAddressValidationRequiredboolean

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

isAdditionalEmailRequiredboolean

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

isPhoneNumberRequiredboolean

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

is MarketingConsentRequiredboolean

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

alertEmailstring

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

typeOfProductinteger

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

Response

200

productIdinteger

namestring

visibilityinteger

billingCurrencystring

billingCurrencyTemplatestring

displayNamestring

descriptionstring

typeOfProductinteger

hasPlansboolean

isShippingAddressRequiredboolean

isShippingAddressValidationRequiredboolean

isBillingAddressValidationRequiredboolean

isAdditionalEmailRequiredboolean

isPhoneNumberRequiredboolean

isMarketingConsentRequiredboolean

numberOfPlansinteger

alertEmailstring

Example response

{
  "productCountryLimitation": {
    "isAnyCountryAllowed": true,
    "countrySettings": [
      {
        "countryIso3": "string",
        "addressPermission": 1
      }
    ]
  },
  "name": "string",
  "billingCurrency": "string",
  "billingCurrencyTemplate": "string",
  "displayName": "string",
  "description": "string",
  "typeOfProduct": 1,
  "hasPlans": true,
  "isShippingAddressRequired": true,
  "isShippingAddressValidationRequired": true,
  "isBillingAddressValidationRequired": true,
  "isAdditionalEmailRequired": true,
  "isPhoneNumberRequired": true,
  "isMarketingConsentRequired": true,
  "alertEmail": "string"
}