Get add-on details

get/{companyDomain}/addons/{addonId}

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/addons/:addonId/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

addonIdinteger required

The unique identifier of the add-on in the Billsby platform

Response

200

addonIdinteger

namestring

displayNamestring

descriptionstring

singleUnitNamestring

pluralUnitNamestring

pricingModelTypestring

hasActiveLinkedPlansboolean

featureTagsstring[]

Example response

{
  "name": "string",
  "displayName": "string",
  "description": "string",
  "singleUnitName": "string",
  "pluralUnitName": "string",
  "pricingModelType": "string",
  "hasActiveLinkedPlans": true,
  "featureTags": [
    "string"
  ],
  "plans": [
    {
      "planName": "string",
      "productName": "string",
      "forceAddon": true,
      "isActive": true
    }
  ],
  "priceModels": [
    {
      "frequencyType": "string",
      "currency": "string",
      "flatFeePriceFormatted": "string",
      "perUnitPriceFormatted": "string",
      "tiers": [
        {
          "priceFormatted": "string"
        }
      ]
    }
  ]
}

Changes

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