PlanSearchFilters

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

  • categoryTypes
    Type: array string[] | null

    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"

  • coverageType
    Type: string · CoverageTypeEnumenumnullable

    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
    • None
    • Powertrain
    • PowertrainPlus
    • MostComprehensive
  • coverageTypes
    Type: array string[] | null

    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.

  • duration
    Type: object · Int32Rangenullable

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

    • from
      Type: integer Format: int32

      Lower bound, inclusive. Omit for no lower bound. To match one exact value, set from and to to the same number.

    • to
      Type: integer Format: int32

      Upper bound, inclusive. Omit for no upper bound.

  • excludeProviders
    Type: array string[] | null

    Exclude specific providers from the results. Useful when you want all providers except certain ones.

  • miles
    Type: object · Int32Rangenullable

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

    • from
      Type: integer Format: int32

      Lower bound, inclusive. Omit for no lower bound. To match one exact value, set from and to to the same number.

    • to
      Type: integer Format: int32

      Upper bound, inclusive. Omit for no upper bound.

  • monthlyPrice
    Type: object · DoubleRangenullable

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

    • from
      Type: number Format: double

      Lower bound, inclusive. Omit for no lower bound. To match one exact value, set from and to to the same number.

    • to
      Type: number Format: double

      Upper bound, inclusive. Omit for no upper bound.

  • numberOfProviders
    Type: integer | null Format: int32

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

  • planChaizRating
    Type: object · DecimalRangenullable

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

    • from
      Type: number Format: double

      Lower bound, inclusive. Omit for no lower bound. To match one exact value, set from and to to the same number.

    • to
      Type: number Format: double

      Upper bound, inclusive. Omit for no upper bound.

  • providers
    Type: array string[] | null

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

  • returnResults
    Type: integer Format: int32

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

  • totalPrice
    Type: object · DoubleRangenullable

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

    • from
      Type: number Format: double

      Lower bound, inclusive. Omit for no lower bound. To match one exact value, set from and to to the same number.

    • to
      Type: number Format: double

      Upper bound, inclusive. Omit for no upper bound.