PartnerSearchResultPlanViewModel
Represents a vehicle protection plan returned from a plan search. Contains pricing, coverage details, provider information, and unique identifiers for ordering.
- accreditedType: array of string | null
By Accreditation organizations for the provider.
- addonsType:Properties: 8
Optional add-ons available for this plan. Add-ons provide additional coverage beyond the base plan.
- categoriesType: object | nullProperties: 1
Dictionary mapping category IDs to category names for covered components.
- coverageType:
Scores Properties: 3Coverage scores by category (e.g., Engine, Transmission, Electrical). Indicates how comprehensive the coverage is for each vehicle system.
- coverageType: Format: int32enum
Type Type of coverage provided by this plan. Values: 1 Powertrain (basic engine/transmission), 2 PowertrainPlus (extended), 3 MostComprehensive (bumper-to-bumper).
values0 = None1 = Powertrain2 = PowertrainPlus3 = MostComprehensive - deductibleType: numberFormat: double
Deductible amount in USD per claim. The amount the customer pays out-of-pocket before coverage kicks in.
- displayType: string | null
Provider Name Display name of the warranty provider.
- downpaymentType: numberFormat: double
Down payment amount in USD required to activate the plan. For monthly payment plans, this is the initial payment.
- durationType: integerFormat: int32
Plan duration in months. Common values: 12, 24, 36, 48, 60 months.
- limitType: string | null
Of Liability Maximum limit of liability per claim or contract term. May be expressed as a dollar amount or vehicle value.
- maintenanceType: nullable
Program Properties: 3The prepaid maintenance program bundled with this plan, or
nullwhen the plan does not include one. Its presence is the availability signal: there is no separate boolean flag on this shape. On theEssentialshape you get ahasMaintenanceProgramboolean instead. - milesType: integerFormat: int32
Coverage mileage limit. The plan covers repairs up to this many miles from the purchase odometer reading.
- monthlyType: numberFormat: double
Price Monthly payment amount in USD for installment plans. Only applicable when PaymentOption is set to monthly payments.
- paymentType:
Options Properties: 11Available payment options with pricing details for each. Includes discounts and installment information.
- payoutType: string | null
Claim payout method. Describes how repairs are paid (e.g., direct to shop, reimbursement).
- planType: number | nullFormat: double
Chaiz Rating Chaiz quality rating for this plan (0-10 scale, one decimal). A proprietary score based on coverage quality, value, and provider reliability.
- planType: string | null
Checkout Url URL to the checkout page for this plan. Partners can redirect customers here to complete purchase.
- planType: string | null
Contract Url URL to the full contract/terms document for this plan.
- planType:
Highlights Properties: 2List of plan highlights or badges. These indicate special qualities like "Best Value", "Most Popular", etc.
- planType: string | null
Name Name of the specific plan.
- planType: string | null
Rating Description Detailed description of why the plan received its rating.
- planType: string | null
Rating Verdict Human-readable verdict summarizing the plan quality. Examples: "Excellent", "Good", "Fair"
- planType: string | null
Summary Url URL to view a summary of plan coverage details.
- providerType: string | null
Info Additional information about the warranty provider. May include company description, years in business, etc.
- providerType: string | null
Logo Url URL to the provider's logo image.
- providerType: number | nullFormat: double
Rating Provider's overall rating (0-5 scale). Based on customer reviews and satisfaction scores.
- recommendationType: string | null
Summary One-line recommendation summary combining the plan's labels, rating, and highlights. Designed for agent-facing display. Null when no recommendation labels are assigned.
- resultType: array of string | null
Labels 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.
- searchType: stringFormat: uuid
Id Unique identifier for the search session that produced this result.
- searchType: integerFormat: int32
Result Plan Id Identifies this plan at this price. Embedded in
planSummaryUrlandplanCheckoutUrl. - totalType: numberFormat: double
Price Total price of the plan in USD, before any payment-option discount. Where the plan is billed monthly this is the total of all installments, which is what a monthly purchase pays across the term; where it is only sold outright it is the upfront cost. Every entry in PaymentOptions publishes this same figure, and what each option actually costs is its TotalPriceAfterDiscount.
- userType: stringFormat: uuid
Id Unique identifier for the user associated with this search.