Product details

Get the details of a specific product

get/{companyDomain}/products/{productId}

Request

Base URL
https://public.billsby.com/api/v1/rest/core
Auth
API key in header ApiKey
TypeScript
https://skmtc.dev/billsby/apis/billsby-api/docs/:companyDomain/products/:productId/get.ts
A function with typed inputs. Its response is checked against the schema.

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

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"
}

Changes

No recorded changes to this operation across all 1 revision of this API.