PartnerPlansSearchRequest

Vehicle information used to search for available protection plans. Required. The fields within depend on the search type (VIN, Make/Model/Year, or License Plate).

Optional filters to narrow down search results by provider, coverage type, price, duration, etc. If not provided, all matching plans are returned.

Your unique partner identifier provided during onboarding. Must match the partner identity in your authentication token.

Optional. Which variant of each plan the result keeps. The response holds one row per planId unless you ask for All. Recommended (default) keeps the shortest duration, then the mileage closest to that duration's baseline (12 months 15k, 24 30k, 36 60k, 48 75k, 60 100k, 72 125k), then the lowest monthly price, then the higher mileage. Highest keeps the highest mileage. Longest keeps the longest duration. All returns every variant, as before this option existed. When omitted, your account's configured default applies; the Partner API default is Recommended. The collapse runs before the limits. numberOfProviders counts providers. The account's result limit counts distinct plans on every surface, also under All: one plan with N variants is one plan and returns N rows. filters.returnResults is applied last and counts rows. When the account groups results to one row per provider (for example bestValuePerProvider), that grouping picks the row and planVariant has no visible effect.

Optional. How much detail the response carries. When omitted, your account's configured detail level applies, and Full when your account sets none. The 200 on these endpoints is documented as one of the two shapes.

Set to Essential for a much smaller payload aimed at lightweight integrations, LLMs, and agents. Each result then keeps only what you need to compare plans, pick one, and send the customer to checkout:

searchResultPlanId, planId, totalPrice, downpayment, monthlyPrice, duration, deductible, miles, planName, displayProviderName, coverageType, planChaizRating, planRatingVerdict, planHighlights, resultLabels, recommendationSummary, planSummaryUrl, and planCheckoutUrl.

Dropped in Essential: the coverage breakdown, per-component scores, add-ons, provider detail, payment-option discounts, and planContractUrl. If you need any of those, stay on Full.

Optional. Controls how the result list is ordered. "recommended" sorts by Chaiz recommendation score, "rating" by Chaiz plan rating, "none" preserves natural order. When omitted, the existing default ordering is used.

Optional. Return cached results from a previous search. Useful for pagination or retrieving the same results without re-executing the search.

When true, includes detailed provider information in the response. Default is false.

Optional UTM parameters and referrer for tracking purposes. Parameters are appended to checkout and summary URLs.

Optional. Associate this search with a specific user ID for tracking purposes. If provided, the search results will be linked to this user.