PartnersPlansSearchViewModel

Response model for plan search operations. Contains the search identifiers, search criteria used, and list of matching plans.

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

    List of matching vehicle protection plans. Each plan includes pricing, coverage details, and a searchResultPlanId for ordering. May be empty if no plans match the search criteria.

    Represents a vehicle protection plan returned from a plan search. Contains pricing, coverage details, provider information, and unique identifiers for ordering.

    • accreditedBy
      Type: array string[] | null

      Accreditation organizations for the provider.

    • addons
      Type: array object[] | null · PartnerAddonViewModel[]

      Optional add-ons available for this plan. Add-ons provide additional coverage beyond the base plan.

      Optional add-on coverage that can be added to a base plan.

    • categories
      Type: object | null

      Dictionary mapping category IDs to category names for covered components.

    • coverageScores
      Type: array object[] | null · PartnerCoverageScoreViewModel[]

      Coverage scores by category (e.g., Engine, Transmission, Electrical). Indicates how comprehensive the coverage is for each vehicle system.

      Coverage score for a specific vehicle system category.

    • 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. The amount the customer pays out-of-pocket before coverage kicks in.

    • displayProviderName
      Type: string | null

      Display name of the warranty provider.

    • downpayment
      Type: numberFormat: double

      Down payment amount in USD required to activate the plan. For monthly payment plans, this is the initial payment.

    • duration
      Type: integerFormat: int32

      Plan duration in months. Common values: 12, 24, 36, 48, 60 months.

    • limitOfLiability
      Type: string | null

      Maximum limit of liability per claim or contract term. May be expressed as a dollar amount or vehicle value.

    • miles
      Type: integerFormat: int32

      Coverage mileage limit. The plan covers repairs up to this many miles from the purchase odometer reading.

    • monthlyPrice
      Type: numberFormat: double

      Monthly payment amount in USD for installment plans. Only applicable when PaymentOption is set to monthly payments.

    • paymentOptions
      Type: array object[] | null · PaymentOptionWithDiscountsViewModel[]

      Available payment options with pricing details for each. Includes discounts and installment information.

      Payment option details including discounts and installment information.

    • payout
      Type: string | null

      Claim payout method. Describes how repairs are paid (e.g., direct to shop, reimbursement).

    • planChaizRating
      Type: number | nullFormat: double

      Chaiz quality rating for this plan (0-100 scale). A proprietary score based on coverage quality, value, and provider reliability.

    • planCheckoutUrl
      Type: string | null

      URL to the checkout page for this plan. Partners can redirect customers here to complete purchase.

    • planContractUrl
      Type: string | null

      URL to the full contract/terms document for this plan.

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

      List of plan highlights or badges. These indicate special qualities like "Best Value", "Most Popular", etc.

      Represents a plan highlight or badge indicating a special quality.

    • planId
      Type: integerFormat: int32

      Signed 32-bit integers (commonly used integer type).

    • planName
      Type: string | null

      Name of the specific plan.

    • planRatingDescription
      Type: string | null

      Detailed description of why the plan received its rating.

    • planRatingVerdict
      Type: string | null

      Human-readable verdict summarizing the plan quality. Examples: "Excellent", "Good", "Fair"

    • planSummaryUrl
      Type: string | null

      URL to view a summary of plan coverage details.

    • providerId
      Type: integerFormat: int32

      Signed 32-bit integers (commonly used integer type).

    • providerInfo
      Type: string | null

      Additional information about the warranty provider. May include company description, years in business, etc.

    • providerLogoUrl
      Type: string | null

      URL to the provider's logo image.

    • providerRating
      Type: number | nullFormat: double

      Provider's overall rating (0-5 scale). Based on customer reviews and satisfaction scores.

    • recommendationSummary
      Type: string | null

      One-line recommendation summary combining the plan's labels, rating, and highlights. Designed for agent-facing display. Null when no recommendation labels are assigned.

    • 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. Null when no labels apply.

    • score
      Type: numberFormat: double
    • searchId
      Type: stringFormat: uuid

      Unique identifier for the search session that produced this result.

    • searchResultPlanId
      Type: integerFormat: int32

      Unique identifier for this plan result. Required for creating an order. Use this value in the CreateOrder endpoint's searchResultPlanIds array.

    • state
      Type: string | null
    • totalPrice
      Type: numberFormat: double

      Total price of the plan in USD. This is the full cost if paid upfront or the total of all installments.

    • userId
      Type: stringFormat: uuid

      Unique identifier for the user associated with this search.

  • searchCriteria
    Type: object · PartnerPlanSearchCriteriaViewModel nullable

    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. Store this ID to reference the search results later.

  • sessionId
    Type: string | nullFormat: uuid

    Session identifier for tracking purposes.

  • userId
    Type: string | nullFormat: uuid

    Unique identifier for the user associated with this search.