PartnersPlansSearchEssentialViewModel

Slim response model for plan search operations. Mirrors Chaiz.API.Models.Partners.V2.PartnersPlansSearchViewModel but its Chaiz.API.Models.Partners.V2.PartnersPlansSearchEssentialViewModel.Results contain only the fields needed for plan comparison, selection, and checkout. Returned when the search request specifies {responseDetailLevel=essential}.

  • results
    Type: array object[] | null · PartnerSearchResultPlanEssentialViewModel[]

    List of matching vehicle protection plans in slim form. May be empty if no plans match the search criteria.

    Slim representation of a partner search result plan, optimized for LLM and lightweight integrations. Contains only the fields needed for plan comparison, selection, and checkout. Returned when the search request specifies {responseDetailLevel=essential}.

    • coverageType
      Type: string · CoverageTypeEnumenum

      Possible values: None (0) - None, Powertrain (1) - Powertrain, PowertrainPlus (2) - PowertrainPlus, MostComprehensive (3) - MostComprehensive

      values
      • None
      • Powertrain
      • PowertrainPlus
      • MostComprehensive
    • deductible
      Type: numberFormat: double

      Deductible amount in USD per claim.

    • displayProviderName
      Type: string | null

      Display name of the warranty provider.

    • downpayment
      Type: numberFormat: double

      Down payment amount in USD required to activate the plan.

    • duration
      Type: integerFormat: int32

      Plan duration in months.

    • miles
      Type: integerFormat: int32

      Coverage mileage limit.

    • monthlyPrice
      Type: numberFormat: double

      Monthly payment amount in USD for installment plans.

    • planChaizRating
      Type: number | nullFormat: double

      Chaiz quality rating for this plan (0-10 scale, one decimal).

    • planCheckoutUrl
      Type: string | null

      URL to the checkout page for this plan.

    • planHighlights
      Type: array object[] | null · PartnerHighlightViewModel[]

      List of plan highlights or badges.

      Represents a plan highlight or badge indicating a special quality.

    • planId
      Type: integerFormat: int32

      Underlying plan identifier, shared across the per-mileage-tier Chaiz.API.Models.Partners.V2.PartnerSearchResultPlanEssentialViewModel.SearchResultPlanId variants of the same plan. Lets lightweight integrations dedup variants down to one plan.

    • planName
      Type: string | null

      Name of the specific plan.

    • planRatingVerdict
      Type: string | null

      Human-readable verdict summarizing the plan quality.

    • planSummaryUrl
      Type: string | null

      URL to view a summary of plan coverage details.

    • recommendationSummary
      Type: string | null

      One-line recommendation summary combining the plan's labels, rating, and highlights.

    • resultLabels
      Type: array string[] | null

      Result-set-relative recommendation labels for this plan. Maximum of 2 labels per plan. Possible values: LOWEST_PRICE, HIGHEST_RATED, BEST_VALUE, BEST_COVERAGE.

    • searchResultPlanId
      Type: integerFormat: int32

      Unique identifier for this plan result. Required for creating an order.

    • totalPrice
      Type: numberFormat: double

      Total price of the plan in USD.

  • searchCriteria
    Type: object · PartnerPlanSearchCriteriaViewModel nullable

    The search criteria that was used for this search.

    Search criteria used for the plan search. Reflects the vehicle and location information provided in the request.

    • licensePlate
      Type: string | null

      License plate number (if license plate search was used).

    • make
      Type: string | null

      Vehicle manufacturer (if Make/Model/Year search was used).

    • mileage
      Type: integerFormat: int32

      Vehicle mileage used for the search.

    • model
      Type: string | null

      Vehicle model (if Make/Model/Year search was used).

    • stateShortName
      Type: string | null

      Two-letter US state code used for the search.

    • vin
      Type: string | null

      Vehicle Identification Number (if VIN search was used).

    • year
      Type: integerFormat: int32

      Vehicle model year (if Make/Model/Year search was used).

    • zip
      Type: string | null

      ZIP code used for the search (if provided).

  • searchId
    Type: string | nullFormat: uuid

    Unique identifier for this search session.

  • sessionId
    Type: string | nullFormat: uuid

    Session identifier for tracking purposes.

  • userId
    Type: string | nullFormat: uuid

    Unique identifier for the user associated with this search.