entitlementsresponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/quickbooks/json-schema/quickbooks-entitlementsresponse-schema.json",
  "title": "entitlementsresponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/quickbooks-entitlements-api-openapi.yml#/components/schemas/entitlementsresponse",
  "type": "object",
  "properties": {
    "PlanName": {
      "type": "string",
      "description": "Billing plan associated with this company."
    },
    "Entitlement": {
      "allOf": [
        {
          "$ref": "#/$defs/telephonenumber"
        }
      ],
      "description": "Primary phone number."
    },
    "SupportedLanguages": {
      "type": "string",
      "description": "Comma separated list of languages."
    },
    "CompanyStartDate": {
      "type": "string",
      "format": "date-time",
      "description": "DateTime when company file was created. This field and Metadata.CreateTime contain the same value."
    },
    "EmployerId": {
      "type": "string",
      "description": "Employer identifier (EIN)."
    },
    "QboCompany": {
      "type": "boolean",
      "description": "Check if the company is a QuickBooks Online company. false is returned if not a QuickBooks Online company, the company exists in the Intuit ecosystem, but is not a QuickBooks Online company, or the company is a QuickBooks Online company, but the current user does not belong to the company."
    },
    "Email": {
      "allOf": [
        {
          "$ref": "#/$defs/emailaddress"
        }
      ],
      "description": "Default email address."
    },
    "WebAddr": {
      "allOf": [
        {
          "$ref": "#/$defs/websiteaddress"
        }
      ],
      "description": "Website address."
    },
    "FiscalYearStartMonth": {
      "type": "string",
      "description": "The start month of fiscal year."
    },
    "Thresholds": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/threshold"
      },
      "description": "The threshold for this company."
    },
    "DaysRemainingTrial": {
      "type": "integer",
      "description": "Remaining trial period days."
    },
    "MaxUsers": {
      "type": "integer",
      "description": "Maximum billable users allowed in the company."
    },
    "CurrentUsers": {
      "type": "integer",
      "description": "Billable users currently in the company."
    }
  },
  "$defs": {
    "emailaddress": {
      "type": "object",
      "title": "emailaddress",
      "properties": {
        "Address": {
          "type": "string",
          "description": "An email address. The address format must follow the RFC 822 standard.",
          "x-intuit-required": "Optional"
        }
      }
    },
    "telephonenumber": {
      "type": "object",
      "title": "telephonenumber",
      "properties": {
        "FreeFormNumber": {
          "type": "string",
          "description": "Specifies the telephone number in free form.",
          "x-intuit-required": "Optional"
        }
      }
    },
    "threshold": {
      "type": "object",
      "title": "threshold",
      "properties": {
        "currentCount": {
          "type": "string",
          "description": "Indicates current value of attribute."
        },
        "aboveThreshold": {
          "type": "string",
          "description": "Indicate whether the current count of the attribute has reached its limit."
        },
        "enforced": {
          "type": "string",
          "description": "Whether the threshold is enforced."
        },
        "limit": {
          "type": "string",
          "description": "The upper limit for the threshold."
        },
        "name": {
          "type": "string",
          "description": "The name of the threshold."
        }
      }
    },
    "websiteaddress": {
      "type": "object",
      "title": "websiteaddress",
      "properties": {
        "URI": {
          "type": "string",
          "description": "Uniform Resource Identifier for the web site.",
          "x-intuit-required": "Optional"
        }
      }
    }
  }
}