PlanSearchFilters

Optional filters to narrow down plan search results. All filters are optional - if not specified, all matching plans are returned.

  • Filter by component coverage categories. Only returns plans that cover specified categories. Values: "Engine", "TurboSuper", "TransferCase", "Steering", "Transmission", "DriveAxle", "Suspension", "AirCon", "Brakes", "Electricals", "Cooling", "Fuel", "Hybrid", "Body", "Consumables", "Exhaust", "General", "Interior", "Services", "Assist"

  • Filter by a single coverage type. Use coverageTypes for multiple values.

    Accepts the canonical names only: Powertrain, PowertrainPlus, MostComprehensive (or 1, 2, 3). The friendly aliases accepted by coverageTypes do not work here.

    values
    0 = None1 = Powertrain2 = PowertrainPlus3 = MostComprehensive
  • Filter by several coverage types at once.

    Accepts either the canonical names (Powertrain, PowertrainPlus, MostComprehensive) or the friendly aliases (basic, basicplus, best), which map to them in that order.

    An unrecognized value is silently ignored rather than rejected, so a typo looks like a filter that had no effect. Results report coverage using the canonical names, so using those here keeps your request and response vocabularies the same.

  • Filter by contract duration range in months. Example: { "from": 24, "to": 60 } for 2-5 year contracts.

    Properties: 2
  • Exclude specific providers from the results. Useful when you want all providers except certain ones.

  • Filter by coverage miles range in thousands. Example: { "from": 50, "to": 150 } for 50K-150K mile coverage. Value of 999 indicates unlimited mileage coverage.

    Properties: 2
  • Filter by monthly payment amount range in USD. Example: { "from": 50, "to": 150 } for $50-$150/month plans.

    Properties: 2
  • Limit the number of unique providers in the results. For example, set to 3 to get plans from at most 3 different providers.

  • Filter by Chaiz plan rating range (0-10 scale). Higher ratings indicate better coverage quality.

    Properties: 2
  • Filter results to only include plans from specific providers. Use provider names like "NAAC", "Omega", "CAPS", "ServiceContract".

  • Maximum number of plan results to return. Default varies by partner configuration.

  • Filter by total plan price range in USD. Example: { "from": 1000, "to": 5000 } for plans between $1,000-$5,000.

    Properties: 2