benefitsOffering

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/oyster-hr/json-schema/oyster-hr-benefits-offering-schema.json",
  "title": "benefitsOffering",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oyster-hr-benefits-api-openapi.yml#/components/schemas/benefitsOffering",
  "properties": {
    "supplementary": {
      "type": "object",
      "properties": {
        "plans": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/benefitPlan"
          }
        }
      }
    },
    "packages": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/benefitPackage"
      }
    }
  },
  "$defs": {
    "benefitPackage": {
      "properties": {
        "id": {
          "type": "string"
        },
        "fee": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "currencyCode": {
              "type": "string",
              "minLength": 3,
              "maxLength": 3
            },
            "decimal": {
              "type": "string",
              "pattern": "^\\d+([.]\\d+)?$"
            }
          }
        },
        "name": {
          "type": "string"
        },
        "plans": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/benefitPlan"
          }
        }
      }
    },
    "benefitPlan": {
      "properties": {
        "category": {
          "type": "string"
        },
        "estimatedPrice": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "currencyCode": {
              "type": "string",
              "minLength": 3,
              "maxLength": 3
            },
            "decimal": {
              "type": "string",
              "pattern": "^\\d+([.]\\d+)?$"
            }
          },
          "required": [
            "currencyCode",
            "decimal"
          ]
        },
        "fee": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "currencyCode": {
              "type": "string",
              "minLength": 3,
              "maxLength": 3
            },
            "decimal": {
              "type": "string",
              "pattern": "^\\d+([.]\\d+)?$"
            }
          },
          "required": [
            "currencyCode",
            "decimal"
          ]
        },
        "guideUrl": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "link": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
}