v1

latestOpenAPI 3.1.02026-07-26580123.9 KB

Get allowance details

get/{companyDomain}/allowances/{allowanceId}

Path parameters

companyDomainstring required

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

allowanceIdinteger required

The unique identifier of the customer in the Billsby platform

Response

200

allowanceIdinteger
namestring
displayNamestring
descriptionstring
singleUnitNamestring
pluralUnitNamestring
pricingModelTypestring
hasActiveLinkedPlansboolean
featureTagsstring[]

Example response

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