v1
latestOpenAPI 3.0.12026-07-243902.3 MBLeads
Get Offer Information for a Lead
If you are choosing to build your own after-market offer UI, you will need to fetch from Extend the product information and the offers for a lead.
The lead-offers endpoint takes a lead token in the request body and responds with all of the product and plan information for that lead.<div class='wrapper important'><h2>Important:</h2>
The lead status parameter should be used to help inform the shopper if the product they are purchasing an extended warranty for is still eligible. You should only allow the shopper to purchase a warranty if the status is live.</div>
get/leads/{leadToken}/offers
Path parameters
leadTokenstring required
Example:17457d13c36f7e2be277603a9d1232de
Unique identifier for a lead
Headers
Content-Typestring required
Example:application/json
Used to indicate the original media type of the resource (prior to any content encoding applied for sending).
X-Extend-Access-Tokenstring required
Example:ExtendAccessToken
An Extend private API key used to authenticate requests.
Acceptstring required
Example:application/json; version=2022-02-01
Indicates which content types, expressed as MIME types, the client is able to understand, as well as identifies which API version to use in the request.
Response
Returns the information
Example response
{
"plans": {
"recommended": "adh",
"adh": [
{
"id": "10001-misc-elec-adh-replace-1y",
"price": 499,
"currencyCode": "USD",
"contract": {
"coverage_starts": "immediate",
"coverage_includes": "adh",
"service_type": "replace",
"replacement_type": "new",
"deductible": 0,
"term_length": 12,
"category": "consumer_electronics"
},
"title": "Extend Protection Plan - 1 Year",
"url": "https://www.extend.com/warranty-plans",
"imageUrl": "https://sdk.helloextend.com/extend_icon.png"
},
{
"id": "10001-misc-elec-adh-replace-2y",
"price": 799,
"currencyCode": "USD",
"contract": {
"coverage_starts": "immediate",
"coverage_includes": "adh",
"service_type": "replace",
"replacement_type": "new",
"deductible": 0,
"term_length": 24,
"category": "consumer_electronics"
},
"title": "Extend Protection Plan - 2 Years",
"url": "https://www.extend.com/warranty-plans",
"imageUrl": "https://sdk.helloextend.com/extend_icon.png"
},
{
"id": "10001-misc-elec-adh-replace-3y",
"price": 999,
"currencyCode": "USD",
"contract": {
"coverage_starts": "immediate",
"coverage_includes": "adh",
"service_type": "replace",
"replacement_type": "new",
"deductible": 0,
"term_length": 36,
"category": "consumer_electronics"
},
"title": "Extend Protection Plan - 3 Years",
"url": "https://www.extend.com/warranty-plans",
"imageUrl": "https://sdk.helloextend.com/extend_icon.png"
}
],
"base": [],
"roadhazard": []
},
"product": {
"listPrice": 4999,
"title": "Wireless Bluetooth Headphones",
"imageUrl": "https://example.com/products/headphones.jpg"
},
"marketing": {
"adh": {
"planId": "10001-misc-elec-adh-replace-1y",
"locale": "en",
"offerTypeButtons": {
"buttonTermLengthYears": "Years",
"headlineCTA": "Add accident protection offered by",
"learnMoreButtonText": "What's covered?"
},
"offerTypeModal": {
"learnMoreButtonText": "What's covered?",
"acceptButton": "Protect my purchase",
"benefit1": "Repairs or replacements",
"benefit1Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/offerModal.bulletIcon1_clock_base_replace.svg",
"benefit2": "Simple claims process",
"benefit2Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/offerModal.bulletIcon2_shield_base_replace.svg",
"benefit3": "Accident protection",
"benefit3Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/offerModal.bulletIcon3_glass_adh_replace.svg",
"buttonLiteralProtectionPlan": "Protection Plan",
"buttonTermLengthYears": "Years",
"declineButton": "I don't want protection",
"footerLegal": "Offered by Extend",
"headline": "Protect your purchase from drops, breaks, spills and defects with Extend",
"headlineMobile": "Get protection from accidents with Extend",
"planBannerBestSeller": "Best Seller!",
"planBannerBestValue": "Best Value!",
"planDetailsLinkText": "Plan details & FAQ"
},
"offerTypeCTA": {
"button": "Add accident protection for"
},
"learnMoreModal": {
"button": "Add accident protection for",
"backgroundImageUrl": "https://s3.amazonaws.com/ccspersistenceprod-contentstaticassets04b201d4-1apqb8dyegznm/offers/learnMoreModal-default-1654273334107-learnMoreModal.backgroundImageUrl_Generic_WomanwithBox2.jpg",
"coverageBullet1": "Repairs or replacements at no additional cost",
"coverageBullet2": "Accidental damage such as breaks and drops",
"coverageBullet2Mobile": "Accidental damage such as breaks and drops",
"coverageBullet3": "Extended failure protection",
"coverageBullet3Mobile": "Extended failure protection",
"coverageBulletsHeading": "This plan covers:",
"headline": "Life happens, so we've got you covered. Protect your purchase from accidental damage from day one through your chosen coverage term.",
"headlineMobile": "Life happens. Protect your purchase from accidental damage from day one through your chosen coverage term.",
"planDetailsLinkText": "Plan details & FAQs",
"whyExtend1": "Simple online claims process",
"whyExtend1Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/learnMoreModal.icon_heart_base_replace.svg",
"whyExtend2": "No deductibles",
"whyExtend2Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/learnMoreModal.icon_0_base_replace.svg",
"whyExtendHeading": "Why choose Extend?"
},
"aftermarketModal": {
"headline": "Protect your purchase from drops, breaks, spills and defects with Extend",
"purchaseInfo1": "Protecting your:",
"purchaseInfo2": "Date of purchase:",
"purchaseInfo3": "Product Value:",
"purchaseInfo4": "Quantity purchased:"
},
"aftermarketModalConsumed": {
"bullet1": "Looks like you already purchased an Extend protection plan for this product!",
"bullet2": "In the meantime, why not check out more eligible products from this store?",
"button": "Continue to store",
"headline": "This product is already protected. Nice!"
},
"aftermarketModalExpired": {
"bullet1": "Uh oh, we cannot offer a protection plan for this product because the manufacturer's warranty is expired or about to expire",
"bullet2": "However, you can add an Extend protection plan on any eligible product you purchase today at checkout from this store!",
"button": "Continue to store",
"headline": "We can no longer offer a plan on this product :-("
}
},
"base": {
"planId": "10001-misc-elec-adh-replace-1y",
"locale": "en",
"offerTypeButtons": {
"buttonTermLengthYears": "Years",
"headlineCTA": "Add accident protection offered by",
"learnMoreButtonText": "What's covered?"
},
"offerTypeModal": {
"learnMoreButtonText": "What's covered?",
"acceptButton": "Protect my purchase",
"benefit1": "Repairs or replacements",
"benefit1Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/offerModal.bulletIcon1_clock_base_replace.svg",
"benefit2": "Simple claims process",
"benefit2Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/offerModal.bulletIcon2_shield_base_replace.svg",
"benefit3": "Accident protection",
"benefit3Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/offerModal.bulletIcon3_glass_adh_replace.svg",
"buttonLiteralProtectionPlan": "Protection Plan",
"buttonTermLengthYears": "Years",
"declineButton": "I don't want protection",
"footerLegal": "Offered by Extend",
"headline": "Protect your purchase from drops, breaks, spills and defects with Extend",
"headlineMobile": "Get protection from accidents with Extend",
"planBannerBestSeller": "Best Seller!",
"planBannerBestValue": "Best Value!",
"planDetailsLinkText": "Plan details & FAQ"
},
"offerTypeCTA": {
"button": "Add accident protection for"
},
"learnMoreModal": {
"button": "Add accident protection for",
"backgroundImageUrl": "https://s3.amazonaws.com/ccspersistenceprod-contentstaticassets04b201d4-1apqb8dyegznm/offers/learnMoreModal-default-1654273334107-learnMoreModal.backgroundImageUrl_Generic_WomanwithBox2.jpg",
"coverageBullet1": "Repairs or replacements at no additional cost",
"coverageBullet2": "Accidental damage such as breaks and drops",
"coverageBullet2Mobile": "Accidental damage such as breaks and drops",
"coverageBullet3": "Extended failure protection",
"coverageBullet3Mobile": "Extended failure protection",
"coverageBulletsHeading": "This plan covers:",
"headline": "Life happens, so we've got you covered. Protect your purchase from accidental damage from day one through your chosen coverage term.",
"headlineMobile": "Life happens. Protect your purchase from accidental damage from day one through your chosen coverage term.",
"planDetailsLinkText": "Plan details & FAQs",
"whyExtend1": "Simple online claims process",
"whyExtend1Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/learnMoreModal.icon_heart_base_replace.svg",
"whyExtend2": "No deductibles",
"whyExtend2Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/learnMoreModal.icon_0_base_replace.svg",
"whyExtendHeading": "Why choose Extend?"
},
"aftermarketModal": {
"headline": "Protect your purchase from drops, breaks, spills and defects with Extend",
"purchaseInfo1": "Protecting your:",
"purchaseInfo2": "Date of purchase:",
"purchaseInfo3": "Product Value:",
"purchaseInfo4": "Quantity purchased:"
},
"aftermarketModalConsumed": {
"bullet1": "Looks like you already purchased an Extend protection plan for this product!",
"bullet2": "In the meantime, why not check out more eligible products from this store?",
"button": "Continue to store",
"headline": "This product is already protected. Nice!"
},
"aftermarketModalExpired": {
"bullet1": "Uh oh, we cannot offer a protection plan for this product because the manufacturer's warranty is expired or about to expire",
"bullet2": "However, you can add an Extend protection plan on any eligible product you purchase today at checkout from this store!",
"button": "Continue to store",
"headline": "We can no longer offer a plan on this product :-("
}
},
"roadhazard": {
"planId": "10001-misc-elec-adh-replace-1y",
"locale": "en",
"offerTypeButtons": {
"buttonTermLengthYears": "Years",
"headlineCTA": "Add accident protection offered by",
"learnMoreButtonText": "What's covered?"
},
"offerTypeModal": {
"learnMoreButtonText": "What's covered?",
"acceptButton": "Protect my purchase",
"benefit1": "Repairs or replacements",
"benefit1Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/offerModal.bulletIcon1_clock_base_replace.svg",
"benefit2": "Simple claims process",
"benefit2Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/offerModal.bulletIcon2_shield_base_replace.svg",
"benefit3": "Accident protection",
"benefit3Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/offerModal.bulletIcon3_glass_adh_replace.svg",
"buttonLiteralProtectionPlan": "Protection Plan",
"buttonTermLengthYears": "Years",
"declineButton": "I don't want protection",
"footerLegal": "Offered by Extend",
"headline": "Protect your purchase from drops, breaks, spills and defects with Extend",
"headlineMobile": "Get protection from accidents with Extend",
"planBannerBestSeller": "Best Seller!",
"planBannerBestValue": "Best Value!",
"planDetailsLinkText": "Plan details & FAQ"
},
"offerTypeCTA": {
"button": "Add accident protection for"
},
"learnMoreModal": {
"button": "Add accident protection for",
"backgroundImageUrl": "https://s3.amazonaws.com/ccspersistenceprod-contentstaticassets04b201d4-1apqb8dyegznm/offers/learnMoreModal-default-1654273334107-learnMoreModal.backgroundImageUrl_Generic_WomanwithBox2.jpg",
"coverageBullet1": "Repairs or replacements at no additional cost",
"coverageBullet2": "Accidental damage such as breaks and drops",
"coverageBullet2Mobile": "Accidental damage such as breaks and drops",
"coverageBullet3": "Extended failure protection",
"coverageBullet3Mobile": "Extended failure protection",
"coverageBulletsHeading": "This plan covers:",
"headline": "Life happens, so we've got you covered. Protect your purchase from accidental damage from day one through your chosen coverage term.",
"headlineMobile": "Life happens. Protect your purchase from accidental damage from day one through your chosen coverage term.",
"planDetailsLinkText": "Plan details & FAQs",
"whyExtend1": "Simple online claims process",
"whyExtend1Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/learnMoreModal.icon_heart_base_replace.svg",
"whyExtend2": "No deductibles",
"whyExtend2Icon": "https://helloextend-static-assets.s3.amazonaws.com/offers-dynamic-messaging/learnMoreModal.icon_0_base_replace.svg",
"whyExtendHeading": "Why choose Extend?"
},
"aftermarketModal": {
"headline": "Protect your purchase from drops, breaks, spills and defects with Extend",
"purchaseInfo1": "Protecting your:",
"purchaseInfo2": "Date of purchase:",
"purchaseInfo3": "Product Value:",
"purchaseInfo4": "Quantity purchased:"
},
"aftermarketModalConsumed": {
"bullet1": "Looks like you already purchased an Extend protection plan for this product!",
"bullet2": "In the meantime, why not check out more eligible products from this store?",
"button": "Continue to store",
"headline": "This product is already protected. Nice!"
},
"aftermarketModalExpired": {
"bullet1": "Uh oh, we cannot offer a protection plan for this product because the manufacturer's warranty is expired or about to expire",
"bullet2": "However, you can add an Extend protection plan on any eligible product you purchase today at checkout from this store!",
"button": "Continue to store",
"headline": "We can no longer offer a plan on this product :-("
}
}
},
"lead": {
"quantity": 1,
"transactionDate": 1647470325503,
"formattedListPrice": "$39.99"
}
}