{ "openapi": "3.0.1", "info": { "title": "productoffermanagementms Service", "description": "productoffermanagementms is a sandbox MS internal to commerce services team.", "version": "2.9.0" }, "servers": [ { "url": "/msapi" } ], "tags": [ { "name": "ProductAvailability V3", "description": "API for product availability operations" }, { "name": "ProductReview V3", "description": "API for product review operations" } ], "paths": { "/productoffermanagementms/v3/product/availability": { "post": { "tags": [ "ProductAvailability V3" ], "summary": "Returns all available products", "description": "API will return all available products ", "operationId": "getProductAvailability", "requestBody": { "description": "Request (PlanRecommendationRequest) Body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductAvailabilityRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "Extender Recommender Tool Response for WBBCRP for Selfservice(plan with addons))": { "summary": "Extender Recommender Tool - WirelessBroadband CRP Response", "value": { "content": { "accountDetails": { "ban": 551795746756 }, "availableProducts": [ { "eligibility": true, "productDetails": [ { "id": "96ad9d5a-1e97-4711-9ba2-8c2bbe71b236", "productType": "WBB_Offer", "productName": "TestOnly_3_Unlimited 5G WBB Bundle_65RC", "productDescription": "Unlimited 5G WBB Bundle.", "benefits": "

5G provides higher speeds, better availability

1000Mbps speeds up to and unlimited data

No contract

Self-Installation With SmartHome Manager

Stream with Ease; great for multiple devices and streaming

$100 Visa Rewards Card included

", "productPrice": { "uom": "month", "base": 45, "total": 45, "taxIncluded": "EXCLUDED" }, "productOriginalPrice": { "uom": "month", "base": 45, "total": 45, "taxIncluded": "EXCLUDED" }, "productMarketingPrice": { "uom": "month", "base": 45, "total": 45, "taxIncluded": "EXCLUDED" }, "productPriceRelationship": [ { "type": "monthlyCharges", "charges": [ { "base": 45, "total": 45, "taxIncluded": "EXCLUDED", "uom": "month" } ] } ], "productOfferingCharacteristic": [ { "name": "SpecialSvc", "localizedName": "SpecialSvc", "valueType": "String", "value": [ { "default": false, "localizedValue": "Low-Income", "value": "LWI" } ] }, { "name": "extenderRecommended", "localizedName": "extenderRecommended", "valueType": "Integer", "value": [ { "default": false, "localizedValue": "3", "value": "3" } ] } ], "productOfferingRelationship": [ { "type": "WBB_Plan", "value": [ { "id": "3cd265b2-ed5e-4433-bf14-30bf94843c2b", "name": "TestOnly_3_Unlimited 5G WBB Plan_65RC", "description": "TestOnly_3_Unlimited 5G WBB Plan_65RC.", "productPrice": { "uom": "month", "base": 45, "total": 45, "taxIncluded": "EXCLUDED" } } ] }, { "type": "discounts", "value": [ { "id": "ImmediatePromotion_205302eb-3fb3-433b-b5ef-5d692fec96c6", "name": "TestOnly_$10 off for 3 months for new and migrating Internet Air", "description": "TestOnly_$10 off for 3 months for new and migrating Internet Air", "applyPolicy": "automatic", "productPrice": { "base": 10, "total": 10, "taxIncluded": "EXCLUDED", "uom": "month" }, "durationPolicy": [ { "uom": "month", "duration": 3 } ], "validForStartDate": "2022-11-06T06:00:00Z", "validForEndDate": "2033-12-26T12:59:39.898Z", "isPromoRolledUp": false, "longDescription": "

Ends XX/XX/XXXX $10 off Extended Wifi Coverage Service for 3 months when purchasing with new Internet Air

" }, { "id": "ImmediatePromotion_8cb9d015-1748-47c8-b278-fc946cc163e8", "name": "TestOnly_$10 off with ACH AutoPay and Paperless Bill", "description": "$10 off when using bank routing for AutoPay Payment", "applyPolicy": "automatic", "productPrice": { "base": 10, "total": 10, "taxIncluded": "EXCLUDED", "uom": "month" }, "durationPolicy": [ { "uom": "month", "duration": 3 } ], "validForStartDate": "2022-11-06T06:00:00Z", "validForEndDate": "2033-12-26T12:59:39.898Z", "isPromoRolledUp": false, "longDescription": "

Ends XX/XX/XXXX $10 off Extended Wifi Coverage Service for 3 months when purchasing with new Internet Air

" } ] }, { "type": "addon", "value": [ { "id": "63fd411b-9ba8-484b-bba5-52797f4c26a1", "name": "Extended Wi-Fi Coverage Service", "description": "Extended Wi-Fi Coverage Service", "productPrice": { "base": 10, "total": 10, "taxIncluded": "EXCLUDED", "uom": "month" }, "currentProductIndicator": true, "equipments": [ { "deviceId": "31f4774c-3ad1-4cb5-8413-450d06a4d49b", "deviceType": "Equipment", "deviceTypeGroup": "BBDevice", "deviceDisplayName": "All-Fi Booster", "upperLimit": 5 } ], "productOfferingRelationship": [ { "type": "discounts", "value": [ { "id": "ImmediatePromotion_205302eb-3fb3-433b-b5ef-5d692fec96c6", "name": "TestOnly_$10 off for 3 months for new and migrating Internet Air", "description": "TestOnly_$10 off for 3 months for new and migrating Internet Air", "applyPolicy": "automatic", "productPrice": { "base": 10, "total": 10, "taxIncluded": "EXCLUDED", "uom": "month", "validForStartDate": "2022-11-06T06:00:00Z", "validForEndDate": "2033-12-26T12:59:39.898Z", "isPromoRolledUp": false, "longDescription": "

Ends XX/XX/XXXX $10 off Extended Wifi Coverage Service for 3 months when purchasing with new Internet Air

" } }, { "id": "ImmediatePromotion_8cb9d015-1748-47c8-b278-fc946cc163e8", "name": "TestOnly_$10 off with ACH AutoPay and Paperless Bill", "description": "$10 off when using bank routing for AutoPay Payment", "applyPolicy": "automatic", "productPrice": { "base": 10, "total": 10, "taxIncluded": "EXCLUDED", "uom": "month", "validForStartDate": "2022-11-06T06:00:00Z", "validForEndDate": "2033-12-26T12:59:39.898Z", "isPromoRolledUp": false, "longDescription": "

Ends XX/XX/XXXX $10 off Extended Wifi Coverage Service for 3 months when purchasing with new Internet Air

" } } ] } ] } ] } ] } ] } ] } } }, "Extender Recommender Tool (ERT) Response": { "summary": "Extender Recommender Tool (ERT) Response", "value": { "content": { "accountDetails": { "ban": "1234567890" }, "cartId": "97da50d0-aa9c-11ec-818f-01c49e663c0c", "checkoutValidation": { "configuration": [ { "status": "complete", "type": "FulfillmentOptions" } ], "validationMessage": [ { "severity": "INFO", "text": "Removal of e-Bill and/or AutoPay will remove discount(s). [Rule ID 33045]" } ] }, "orderTotalPrice": [ { "type": "proratedCharges", "charges": { "base": 0, "payImmediately": false, "uom": "OC", "chargeType": "credit" } }, { "type": "recurringCharges", "charges": { "base": 45, "payImmediately": false, "uom": "month" } }, { "type": "oneTimeCharges", "charges": { "base": 0, "payImmediately": false, "uom": "OC" } }, { "type": "recurringTaxes", "charges": { "base": 0, "uom": "month", "payImmediately": false } }, { "type": "proratedTaxes", "charges": { "base": 0, "uom": "OC", "payImmediately": false, "chargeType": "credit" } }, { "type": "govtFeesBreakup", "govtCharges": [ { "description": "Chicago Lease tax", "taxRate": 0.09000000357627869, "base": 0, "uom": "oc", "payImmediately": false } ] } ], "productDetails": [ { "id": "52165303-5d47-4827-a51c-f7ab08570210", "currentProductIndicator": false, "productOrderItemId": "83f0072a-d578-46a1-ba23-59accea41f0a", "productType": "WBB_Offer", "productDescription": "AT&T Internet Air", "productPriceRelationship": [ { "type": "proratedCharges", "charges": { "base": 0, "taxIncluded": "Excluded", "payImmediately": false, "uom": "OC", "chargeType": "credit" } }, { "type": "recurringCharges", "charges": { "base": 35, "taxIncluded": "Excluded", "payImmediately": false, "uom": "month", "chargeType": "credit" } } ], "productOfferingCharacteristic": [], "productRelationship": [ { "type": "equipment", "value": [ { "deviceId": "65838021382177962", "deviceType": "WBBDevice", "displayName": "Extended Wi-Fi Coverage Service" } ] } ], "productOrderRelationship": [ { "type": "fulfillmentOptions", "fulfillmentOptions": [ { "id": "c501a63e-97bc-4663-9327-fe2253f3e4b8", "shipmentDates": { "from": "2022-03-28", "to": "2022-03-30" }, "deliveryDates": { "from": "2022-03-29", "to": "2022-03-31" }, "deliveryMethod": "Standard Shipping 2 Days", "deliverycharges": { "base": 2, "total": 2, "uom": "OC" } } ] }, { "type": "termsAndConditions", "termsAndConditions": [ { "type": "ECONSENT", "version": "v5", "title": "Consent to Electronic Delivery of Disclosures", "text": "I have read and agree to the Consent to Electronic Delivery of Disclosures and Communications", "url": "idpassets/archive-legal/fragment/legal/prod/lpc/terms/electronicCommunicationsConsent/v5/electronicCommunicationsConsent.cmsfeed.js", "readAloudText": "Let's review your credit. Don't worry, we'll do a soft credit inquiry which means it won't hurt your credit score.<br/> - We'll use your info only to qualify you for service with us.<br/>- Based on your credit, we may ask for a pre-payment today" } ] } ] }, { "id": "227860ce-9be2-4a6f-80ff-150e4959dec1", "currentProductIndicator": true, "productOrderItemId": "f4446282-f4da-4f6e-aef9-d88e8bd1ed34", "productType": "WBB_Offer", "productDescription": "AT&T Internet Air", "productOfferingCharacteristic": [], "productPriceRelationship": [ { "type": "proratedCharges", "charges": { "base": 0, "taxIncluded": "Excluded", "payImmediately": false, "uom": "OC", "chargeType": "credit" } }, { "type": "recurringCharges", "charges": { "base": 50, "total": 54.13, "uom": "month", "payImmediately": false } }, { "type": "marketingMonthlyCharges", "charges": { "base": 15, "total": 15, "uom": "month", "chargeType": "credit" } } ], "productOrderRelationship": [ { "type": "fulfillmentOptions", "fulfillmentOptions": [ { "id": "c501a63e-97bc-4663-9327-fe2253f3e4b8", "shipmentDates": { "from": "2024-01-28", "to": "2024-01-30" }, "deliveryDates": { "from": "2024-01-29", "to": "2022-01-31" }, "deliveryMethod": "Standard Shipping 2 Days", "deliverycharges": { "base": 2, "total": 2, "uom": "OC" } } ] }, { "type": "termsAndConditions", "termsAndConditions": [ { "type": "ECONSENT", "version": "v11", "title": "Consent to Electronic Delivery of Disclosures", "text": "I have read and agree to the Consent to Electronic Delivery of Disclosures.", "url": "/idpassets/archive-legal/fragment/legal/prod/lpc/terms/electronicCommunicationsConsent/v11/electronicCommunicationsConsent.cmsfeed.js", "readAloudText": "Keep an eye out for the email with a link to your terms and conditions. You must review and accept your terms and conditions before you can activate your new wifi extender service." } ] } ], "productOfferingRelationship": [ { "type": "WBB_Plan", "value": [ { "id": "999c315b-ed5e-4433-bf14-30bf94843c2b", "name": "AT&T Internet Air", "productPriceRelationship": [ { "type": "proratedCharges", "charges": { "base": 0, "payImmediately": false, "taxIncluded": "Excluded", "uom": "OC" } }, { "type": "recurringCharges", "charges": { "base": 50, "total": 54.13, "uom": "month", "payImmediately": false } } ] } ] }, { "type": "discount", "value": [ { "id": "ImmediatePromotion_984188c6-f4d5-4672-864a-c08fb319ac05", "name": "$5 off with AutoPay and Paperless Bill", "description": "Includes $5 off with AutoPay and Paperless Bill", "applyPolicy": "automatic", "productPriceRelationship": [ { "type": "recurringCharges", "charges": { "base": 5, "total": 5.41, "uom": "OC", "payImmediately": false } } ] }, { "id": "ImmediatePromotion_a4f7689d-f3e2-419a-a533-4981c4257d01", "name": "TestOnly_$10 off for 3 months for new and migrating Internet Air", "description": "TestOnly_$10 off for 3 months for new and migrating Internet Air", "applyPolicy": "automatic", "productPriceRelationship": [ { "type": "recurringCharges", "charges": { "base": 10, "total": 10.82, "uom": "OC", "payImmediately": false } } ] } ] } ] }, { "id": "prod11270288", "productOrderItemId": "cfdc47f2-785d-40cb-a957-c3dfc92c6cb9", "productType": "Coverage", "productDescription": "Extended Wi-Fi Coverage Service", "productPriceRelationship": [ { "type": "proratedCharges", "charges": { "base": 0, "taxIncluded": "Excluded", "payImmediately": false, "uom": "OC", "chargeType": "credit" } }, { "type": "recurringCharges", "charges": { "base": 10, "taxIncluded": "Excluded", "payImmediately": false, "uom": "month", "chargeType": "credit" } } ], "productRelationship": [ { "type": "Equipment", "equipmentInfo": [ { "deviceType": "BBDevice", "displayName": "All-Fi Booster" } ] }, { "type": "Equipment", "equipmentInfo": [ { "deviceType": "BBDevice", "displayName": "All-Fi Booster" } ] }, { "type": "Equipment", "equipmentInfo": [ { "deviceType": "BBDevice", "displayName": "All-Fi Booster" } ] } ], "productOrderRelationship": [ { "type": "fulfillmentOptions", "fulfillmentOptions": [ { "id": "c501a63e-97bc-4663-9327-fe2253f3e4b8", "shipmentDates": { "from": "2022-03-28", "to": "2022-03-30" }, "deliveryDates": { "from": "2022-03-29", "to": "2022-03-31" }, "deliveryMethod": "Standard Shipping 2 Days", "deliverycharges": { "base": 2, "total": 2, "uom": "OC" } } ] } ], "productOfferingRelationship": [ { "type": "discount", "value": [ { "id": "ImmediatePromotion_984188c6-f4d5-4672-864a-c08fb319ac05", "name": "TestOnly_$10 for new Internet Air", "description": "TestOnly_$10 for new Internet Air", "applyPolicy": "automatic", "productPriceRelationship": [ { "type": "recurringCharges", "charges": { "base": 10, "total": 10.82, "uom": "OC", "payImmediately": false } } ] } ] } ] } ] } } } } } } }, "404": { "description": "Not Found" } } } }, "/productoffermanagementms/v3/product/review": { "post": { "tags": [ "ProductReview V3" ], "summary": "Product Change review", "description": "API for reviewing the product change.", "operationId": "productChangeReview", "requestBody": { "description": "Request (ChangePlanReviewRequest) Body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePlanReviewRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "examples": { "WBB CRP Extender Recommended Tool ProductPurchase Response22": { "summary": "WBB CRP Extender Recommended Tool review", "value": { "content": { "accountDetails": { "ban": "1234567890" }, "cartId": "97da50d0-aa9c-11ec-818f-01c49e663c0c", "checkoutValidation": { "configuration": [ { "status": "complete", "type": "FulfillmentOptions" } ], "validationMessage": [ { "severity": "INFO", "text": "Removal of e-Bill and/or AutoPay will remove discount(s). [Rule ID 33045]" } ] }, "orderTotalPrice": [ { "type": "proratedCharges", "charges": { "base": 0, "payImmediately": false, "uom": "OC", "chargeType": "credit" } }, { "type": "recurringCharges", "charges": { "base": 45, "payImmediately": false, "uom": "month" } }, { "type": "oneTimeCharges", "charges": { "base": 0, "payImmediately": false, "uom": "OC" } }, { "type": "recurringTaxes", "charges": { "base": 0, "uom": "month", "payImmediately": false } }, { "type": "proratedTaxes", "charges": { "base": 0, "uom": "OC", "payImmediately": false, "chargeType": "credit" } }, { "type": "govtFeesBreakup", "govtCharges": [ { "description": "Chicago Lease tax", "taxRate": 0.09000000357627869, "base": 0, "uom": "oc", "payImmediately": false } ] } ], "productDetails": [ { "id": "52165303-5d47-4827-a51c-f7ab08570210", "currentProductIndicator": false, "productOrderItemId": "83f0072a-d578-46a1-ba23-59accea41f0a", "productType": "WBB_Offer", "productDescription": "AT&T Internet Air", "productPriceRelationship": [ { "type": "proratedCharges", "charges": { "base": 0, "taxIncluded": "Excluded", "payImmediately": false, "uom": "OC", "chargeType": "credit" } }, { "type": "recurringCharges", "charges": { "base": 35, "taxIncluded": "Excluded", "payImmediately": false, "uom": "month", "chargeType": "credit" } } ], "productOfferingCharacteristic": [], "productRelationship": [ { "type": "equipment", "value": [ { "deviceId": "65838021382177962", "deviceType": "WBBDevice", "displayName": "Extended Wi-Fi Coverage Service" } ] } ], "productOrderRelationship": [ { "type": "fulfillmentOptions", "fulfillmentOptions": [ { "id": "c501a63e-97bc-4663-9327-fe2253f3e4b8", "shipmentDates": { "from": "2022-03-28", "to": "2022-03-30" }, "deliveryDates": { "from": "2022-03-29", "to": "2022-03-31" }, "deliveryMethod": "Standard Shipping 2 Days", "deliverycharges": { "base": 2, "total": 2, "uom": "OC" } } ] }, { "type": "termsAndConditions", "termsAndConditions": [ { "type": "ECONSENT", "version": "v5", "title": "Consent to Electronic Delivery of Disclosures", "text": "I have read and agree to the Consent to Electronic Delivery of Disclosures and Communications", "url": "idpassets/archive-legal/fragment/legal/prod/lpc/terms/electronicCommunicationsConsent/v5/electronicCommunicationsConsent.cmsfeed.js", "readAloudText": "Let's review your credit. Don't worry, we'll do a soft credit inquiry which means it won't hurt your credit score.
- We'll use your info only to qualify you for service with us.
- Based on your credit, we may ask for a pre-payment today" } ] } ] }, { "id": "227860ce-9be2-4a6f-80ff-150e4959dec1", "currentProductIndicator": true, "productOrderItemId": "f4446282-f4da-4f6e-aef9-d88e8bd1ed34", "productType": "WBB_Offer", "productDescription": "AT&T Internet Air", "productOfferingCharacteristic": [], "productPriceRelationship": [ { "type": "proratedCharges", "charges": { "base": 0, "taxIncluded": "Excluded", "payImmediately": false, "uom": "OC", "chargeType": "credit" } }, { "type": "recurringCharges", "charges": { "base": 50, "total": 54.13, "uom": "month", "payImmediately": false } }, { "type": "marketingMonthlyCharges", "charges": { "base": 15, "total": 15, "uom": "month", "chargeType": "credit" } } ], "productOrderRelationship": [ { "type": "fulfillmentOptions", "fulfillmentOptions": [ { "id": "c501a63e-97bc-4663-9327-fe2253f3e4b8", "shipmentDates": { "from": "2024-01-28", "to": "2024-01-30" }, "deliveryDates": { "from": "2024-01-29", "to": "2022-01-31" }, "deliveryMethod": "Standard Shipping 2 Days", "deliverycharges": { "base": 2, "total": 2, "uom": "OC" } } ] }, { "type": "termsAndConditions", "termsAndConditions": [ { "type": "ECONSENT", "version": "v11", "title": "Consent to Electronic Delivery of Disclosures", "text": "I have read and agree to the Consent to Electronic Delivery of Disclosures.", "url": "/idpassets/archive-legal/fragment/legal/prod/lpc/terms/electronicCommunicationsConsent/v11/electronicCommunicationsConsent.cmsfeed.js", "readAloudText": "Keep an eye out for the email with a link to your terms and conditions. You must review and accept your terms and conditions before you can activate your new wifi extender service." } ] } ], "productOfferingRelationship": [ { "type": "WBB_Plan", "value": [ { "id": "999c315b-ed5e-4433-bf14-30bf94843c2b", "name": "AT&T Internet Air", "productPriceRelationship": [ { "type": "proratedCharges", "charges": { "base": 0, "payImmediately": false, "taxIncluded": "Excluded", "uom": "OC" } }, { "type": "recurringCharges", "charges": { "base": 50, "total": 54.13, "uom": "month", "payImmediately": false } } ] } ] }, { "type": "discount", "value": [ { "id": "ImmediatePromotion_984188c6-f4d5-4672-864a-c08fb319ac05", "name": "$5 off with AutoPay and Paperless Bill", "description": "Includes $5 off with AutoPay and Paperless Bill", "applyPolicy": "automatic", "productPriceRelationship": [ { "type": "recurringCharges", "charges": { "base": 5, "total": 5.41, "uom": "OC", "payImmediately": false } } ] }, { "id": "ImmediatePromotion_a4f7689d-f3e2-419a-a533-4981c4257d01", "name": "TestOnly_$10 off for 3 months for new and migrating Internet Air", "description": "TestOnly_$10 off for 3 months for new and migrating Internet Air", "applyPolicy": "automatic", "productPriceRelationship": [ { "type": "recurringCharges", "charges": { "base": 10, "total": 10.82, "uom": "OC", "payImmediately": false } } ] } ] } ] }, { "id": "prod11270288", "productOrderItemId": "cfdc47f2-785d-40cb-a957-c3dfc92c6cb9", "productType": "Coverage", "productDescription": "Extended Wi-Fi Coverage Service", "productPriceRelationship": [ { "type": "proratedCharges", "charges": { "base": 0, "taxIncluded": "Excluded", "payImmediately": false, "uom": "OC", "chargeType": "credit" } }, { "type": "recurringCharges", "charges": { "base": 10, "taxIncluded": "Excluded", "payImmediately": false, "uom": "month", "chargeType": "credit" } } ], "productRelationship": [ { "type": "Equipment", "equipmentInfo": [ { "deviceType": "BBDevice", "displayName": "All-Fi Booster" } ] }, { "type": "Equipment", "equipmentInfo": [ { "deviceType": "BBDevice", "displayName": "All-Fi Booster" } ] }, { "type": "Equipment", "equipmentInfo": [ { "deviceType": "BBDevice", "displayName": "All-Fi Booster" } ] } ], "productOrderRelationship": [ { "type": "fulfillmentOptions", "fulfillmentOptions": [ { "id": "c501a63e-97bc-4663-9327-fe2253f3e4b8", "shipmentDates": { "from": "2022-03-28", "to": "2022-03-30" }, "deliveryDates": { "from": "2022-03-29", "to": "2022-03-31" }, "deliveryMethod": "Standard Shipping 2 Days", "deliverycharges": { "base": 2, "total": 2, "uom": "OC" } } ] } ], "productOfferingRelationship": [ { "type": "discount", "value": [ { "id": "ImmediatePromotion_984188c6-f4d5-4672-864a-c08fb319ac05", "name": "TestOnly_$10 for new Internet Air", "description": "TestOnly_$10 for new Internet Air", "applyPolicy": "automatic", "productPriceRelationship": [ { "type": "recurringCharges", "charges": { "base": 10, "total": 10.82, "uom": "OC", "payImmediately": false } } ] } ] } ] } ] } } }, "WBB CRP Extender Recommended Tool ProductPurchase Response": { "summary": "WBB CRP Extender Recommended Tool ProductPurchase Response", "value": { "content": { "accountDetails": { "ban": "556298728238" }, "cartId": "07fe7240-a626-11f1-9f78-5ddf394e8c0a", "productOrderItemId": "598dabcc-e665-4906-9020-54da12f65dcd", "checkoutValidation": { "configuration": [ { "status": "incomplete", "type": "FulfillmentOptions" }, { "status": "complete", "type": "Terms" } ] }, "productDetails": [ { "productCode": "598dabcc-e665-4906-9020-54da12f65dcd", "productType": "Coverage", "productDescription": "Extended Wi-Fi Coverage Service", "productPriceRelationship": [ { "type": "ProratedCharges", "proratedCharges": { "base": 11.2, "total": 12.12, "uom": "month" }, "originalProratedCharges": { "base": 11.2, "total": 12.12, "uom": "month" } }, { "type": "MonthlyCharges", "monthlyCharges": { "base": 12, "total": 12.99, "uom": "month" }, "originalMonthlyCharges": { "base": 12, "total": 12.99, "uom": "month" }, "marketingMonthlyCharges": { "base": 12, "total": 12, "uom": "month" } } ], "productRelationship": [ { "type": "Equipment", "equipmentInfo": [ { "deviceType": "BBDevice", "displayName": "All-Fi Booster" } ] }, { "type": "Equipment", "equipmentInfo": [ { "deviceType": "BBDevice", "displayName": "All-Fi Booster" } ] }, { "type": "Equipment", "equipmentInfo": [ { "deviceType": "BBDevice", "displayName": "All-Fi Booster" } ] } ], "productOrderRelationship": [ { "type": "dueToday", "dueToday": { "base": 11.2, "total": 12.12, "uom": "OC", "payImmediately": false } }, { "type": "taxes", "taxes": { "base": 0.92, "total": 0.92, "uom": "OC", "payImmediately": false } }, { "type": "govtFees", "govtFees": { "base": 0.9199999999999999, "uom": "USD" } }, { "type": "govtFeesBreakup", "govtFeesBreakup": [ { "description": "TX State Sales Tax", "taxRate": 0.0625, "base": 0.7, "uom": "OC", "payImmediately": false }, { "description": "City Sales Tax", "taxRate": 0.01, "base": 0.11, "uom": "OC", "payImmediately": false }, { "description": "District Sales Tax", "taxRate": 0.01, "base": 0.11, "uom": "OC", "payImmediately": false } ] }, { "type": "termsAndConditions", "termsAndConditions": [ { "type": "CSA", "version": "v38", "title": "AT&T Consumer Service Agreement", "text": "I have read and agree to the AT&T Consumer Service Agreement (and the included provisions for binding individual arbitration rather than jury trials or class actions), under which service will auto-renew monthly until cancelled.", "url": "/idpassets/archive-legal/fragment/legal/prod/lpc/terms/consumerServiceAgreement/v38/consumerServiceAgreement.cmsfeed.js" }, { "type": "MRC_GEN", "version": "v1", "title": "Service Disclosures & Consent", "text": "By checking this box, you agree that the service(s) you have selected will automatically renew each month based on the rates in effect at the time of renewal, minus any discounts or promotions you qualify for (currently the rate shown on the screen). This will continue until you cancel the service. To avoid further charges, cancel before the end of your monthly billing cycle by visiting att.com/cancel-info or calling 1-800-288-2020.", "url": "/msapi/sales/termsandconditions/v1/termscontent/MRC_GEN" } ] }, { "type": "fulfillmentOptions", "fulfillmentOptions": [ { "id": "83c8f5a0-d210-4c2c-a7a2-35e27ec193a3", "shipmentDates": { "fromDate": "2026-09-02", "toDate": "2026-09-04" }, "deliveryDates": { "fromDate": "2026-09-03", "toDate": "2026-09-07" }, "deliveryMethod": "Standard Shipping", "fulfillmentMethod": "DF" } ] } ] } ], "isIncompatibleDevice": false } } }, "WBB CRP Extender Recommended Tool Response": { "summary": "WBB CRP Extender Recommended Tool Response", "value": { "content": { "accountDetails": { "ban": "1234567890" }, "cartId": "97da50d0-aa9c-11ec-818f-01c49e663c0c", "checkoutValidation": { "configuration": [ { "status": "complete", "type": "FulfillmentOptions" } ], "validationMessage": [ { "severity": "INFO", "text": "Removal of e-Bill and/or AutoPay will remove discount(s). [Rule ID 33045]" } ] }, "orderTotalPrice": [ { "type": "proratedCharges", "charges": { "base": 0, "payImmediately": false, "uom": "OC", "chargeType": "credit" } }, { "type": "recurringCharges", "charges": { "base": 45, "payImmediately": false, "uom": "month" } }, { "type": "oneTimeCharges", "charges": { "base": 0, "payImmediately": false, "uom": "OC" } }, { "type": "recurringTaxes", "charges": { "base": 0, "uom": "month", "payImmediately": false } }, { "type": "proratedTaxes", "charges": { "base": 0, "uom": "OC", "payImmediately": false, "chargeType": "credit" } }, { "type": "govtFeesBreakup", "govtCharges": [ { "description": "Chicago Lease tax", "taxRate": 0.09000000357627869, "base": 0, "uom": "oc", "payImmediately": false } ] } ], "productDetails": [ { "id": "52165303-5d47-4827-a51c-f7ab08570210", "currentProductIndicator": false, "productOrderItemId": "83f0072a-d578-46a1-ba23-59accea41f0a", "productType": "WBB_Offer", "productDescription": "AT&T Internet Air", "productPriceRelationship": [ { "type": "proratedCharges", "charges": { "base": 0, "taxIncluded": "Excluded", "payImmediately": false, "uom": "OC", "chargeType": "credit" } }, { "type": "recurringCharges", "charges": { "base": 35, "taxIncluded": "Excluded", "payImmediately": false, "uom": "month", "chargeType": "credit" } } ], "productOfferingCharacteristic": [], "productRelationship": [ { "type": "equipment", "value": [ { "deviceId": "65838021382177962", "deviceType": "WBBDevice", "displayName": "Extended Wi-Fi Coverage Service" } ] } ], "productOrderRelationship": [ { "type": "fulfillmentOptions", "fulfillmentOptions": [ { "id": "c501a63e-97bc-4663-9327-fe2253f3e4b8", "shipmentDates": { "from": "2022-03-28", "to": "2022-03-30" }, "deliveryDates": { "from": "2022-03-29", "to": "2022-03-31" }, "deliveryMethod": "Standard Shipping 2 Days", "deliverycharges": { "base": 2, "total": 2, "uom": "OC" } } ] }, { "type": "termsAndConditions", "termsAndConditions": [ { "type": "ECONSENT", "version": "v5", "title": "Consent to Electronic Delivery of Disclosures", "text": "I have read and agree to the Consent to Electronic Delivery of Disclosures and Communications", "url": "idpassets/archive-legal/fragment/legal/prod/lpc/terms/electronicCommunicationsConsent/v5/electronicCommunicationsConsent.cmsfeed.js", "readAloudText": "Let's review your credit. Don't worry, we'll do a soft credit inquiry which means it won't hurt your credit score.
- We'll use your info only to qualify you for service with us.
- Based on your credit, we may ask for a pre-payment today" } ] } ] }, { "id": "227860ce-9be2-4a6f-80ff-150e4959dec1", "currentProductIndicator": true, "productOrderItemId": "f4446282-f4da-4f6e-aef9-d88e8bd1ed34", "productType": "WBB_Offer", "productDescription": "AT&T Internet Air", "productOfferingCharacteristic": [], "productPriceRelationship": [ { "type": "proratedCharges", "charges": { "base": 0, "taxIncluded": "Excluded", "payImmediately": false, "uom": "OC", "chargeType": "credit" } }, { "type": "recurringCharges", "charges": { "base": 50, "total": 54.13, "uom": "month", "payImmediately": false } }, { "type": "marketingMonthlyCharges", "charges": { "base": 15, "total": 15, "uom": "month", "chargeType": "credit" } } ], "productOrderRelationship": [ { "type": "fulfillmentOptions", "fulfillmentOptions": [ { "id": "c501a63e-97bc-4663-9327-fe2253f3e4b8", "shipmentDates": { "from": "2024-01-28", "to": "2024-01-30" }, "deliveryDates": { "from": "2024-01-29", "to": "2022-01-31" }, "deliveryMethod": "Standard Shipping 2 Days", "deliverycharges": { "base": 2, "total": 2, "uom": "OC" } } ] }, { "type": "termsAndConditions", "termsAndConditions": [ { "type": "ECONSENT", "version": "v11", "title": "Consent to Electronic Delivery of Disclosures", "text": "I have read and agree to the Consent to Electronic Delivery of Disclosures.", "url": "/idpassets/archive-legal/fragment/legal/prod/lpc/terms/electronicCommunicationsConsent/v11/electronicCommunicationsConsent.cmsfeed.js", "readAloudText": "Keep an eye out for the email with a link to your terms and conditions. You must review and accept your terms and conditions before you can activate your new wifi extender service." } ] } ], "productOfferingRelationship": [ { "type": "WBB_Plan", "value": [ { "id": "999c315b-ed5e-4433-bf14-30bf94843c2b", "name": "AT&T Internet Air", "productPriceRelationship": [ { "type": "proratedCharges", "charges": { "base": 0, "payImmediately": false, "taxIncluded": "Excluded", "uom": "OC" } }, { "type": "recurringCharges", "charges": { "base": 50, "total": 54.13, "uom": "month", "payImmediately": false } } ] } ] }, { "type": "discount", "value": [ { "id": "ImmediatePromotion_984188c6-f4d5-4672-864a-c08fb319ac05", "name": "$5 off with AutoPay and Paperless Bill", "description": "Includes $5 off with AutoPay and Paperless Bill", "applyPolicy": "automatic", "productPriceRelationship": [ { "type": "recurringCharges", "charges": { "base": 5, "total": 5.41, "uom": "OC", "payImmediately": false } } ] }, { "id": "ImmediatePromotion_a4f7689d-f3e2-419a-a533-4981c4257d01", "name": "TestOnly_$10 off for 3 months for new and migrating Internet Air", "description": "TestOnly_$10 off for 3 months for new and migrating Internet Air", "applyPolicy": "automatic", "productPriceRelationship": [ { "type": "recurringCharges", "charges": { "base": 10, "total": 10.82, "uom": "OC", "payImmediately": false } } ] } ] } ] }, { "id": "prod11270288", "productOrderItemId": "cfdc47f2-785d-40cb-a957-c3dfc92c6cb9", "productType": "Coverage", "productDescription": "Extended Wi-Fi Coverage Service", "productPriceRelationship": [ { "type": "proratedCharges", "charges": { "base": 0, "taxIncluded": "Excluded", "payImmediately": false, "uom": "OC", "chargeType": "credit" } }, { "type": "recurringCharges", "charges": { "base": 10, "taxIncluded": "Excluded", "payImmediately": false, "uom": "month", "chargeType": "credit" } } ], "productRelationship": [ { "type": "Equipment", "equipmentInfo": [ { "deviceType": "BBDevice", "displayName": "All-Fi Booster" } ] }, { "type": "Equipment", "equipmentInfo": [ { "deviceType": "BBDevice", "displayName": "All-Fi Booster" } ] }, { "type": "Equipment", "equipmentInfo": [ { "deviceType": "BBDevice", "displayName": "All-Fi Booster" } ] } ], "productOrderRelationship": [ { "type": "fulfillmentOptions", "fulfillmentOptions": [ { "id": "c501a63e-97bc-4663-9327-fe2253f3e4b8", "shipmentDates": { "from": "2022-03-28", "to": "2022-03-30" }, "deliveryDates": { "from": "2022-03-29", "to": "2022-03-31" }, "deliveryMethod": "Standard Shipping 2 Days", "deliverycharges": { "base": 2, "total": 2, "uom": "OC" } } ] } ], "productOfferingRelationship": [ { "type": "discount", "value": [ { "id": "ImmediatePromotion_984188c6-f4d5-4672-864a-c08fb319ac05", "name": "TestOnly_$10 for new Internet Air", "description": "TestOnly_$10 for new Internet Air", "applyPolicy": "automatic", "productPriceRelationship": [ { "type": "recurringCharges", "charges": { "base": 10, "total": 10.82, "uom": "OC", "payImmediately": false } } ] } ] } ] } ] } } }, "Extender Recommender Tool Response for WBBCRP ProductPurchase Review": { "summary": "Extender Recommender Tool Response for WBBCRP ProductPurchase Review", "value": { "content": { "accountDetails": { "ban": "556298728238" }, "cartId": "07fe7240-a626-11f1-9f78-5ddf394e8c0a", "productOrderItemId": "598dabcc-e665-4906-9020-54da12f65dcd", "checkoutValidation": { "configuration": [ { "status": "incomplete", "type": "FulfillmentOptions" }, { "status": "complete", "type": "Terms" } ] }, "productDetails": [ { "productCode": "598dabcc-e665-4906-9020-54da12f65dcd", "productType": "Coverage", "productDescription": "Extended Wi-Fi Coverage Service", "productPriceRelationship": [ { "type": "ProratedCharges", "proratedCharges": { "base": 11.2, "total": 12.12, "uom": "month" }, "originalProratedCharges": { "base": 11.2, "total": 12.12, "uom": "month" } }, { "type": "MonthlyCharges", "monthlyCharges": { "base": 12, "total": 12.99, "uom": "month" }, "originalMonthlyCharges": { "base": 12, "total": 12.99, "uom": "month" }, "marketingMonthlyCharges": { "base": 12, "total": 12, "uom": "month" } } ], "productRelationship": [ { "type": "Equipment", "equipmentInfo": [ { "deviceType": "BBDevice", "displayName": "All-Fi Booster" } ] }, { "type": "Equipment", "equipmentInfo": [ { "deviceType": "BBDevice", "displayName": "All-Fi Booster" } ] }, { "type": "Equipment", "equipmentInfo": [ { "deviceType": "BBDevice", "displayName": "All-Fi Booster" } ] } ], "productOrderRelationship": [ { "type": "dueToday", "dueToday": { "base": 11.2, "total": 12.12, "uom": "OC", "payImmediately": false } }, { "type": "taxes", "taxes": { "base": 0.92, "total": 0.92, "uom": "OC", "payImmediately": false } }, { "type": "govtFees", "govtFees": { "base": 0.9199999999999999, "uom": "USD" } }, { "type": "govtFeesBreakup", "govtFeesBreakup": [ { "description": "TX State Sales Tax", "taxRate": 0.0625, "base": 0.7, "uom": "OC", "payImmediately": false }, { "description": "City Sales Tax", "taxRate": 0.01, "base": 0.11, "uom": "OC", "payImmediately": false }, { "description": "District Sales Tax", "taxRate": 0.01, "base": 0.11, "uom": "OC", "payImmediately": false } ] }, { "type": "termsAndConditions", "termsAndConditions": [ { "type": "CSA", "version": "v38", "title": "AT&T Consumer Service Agreement", "text": "I have read and agree to the AT&T Consumer Service Agreement (and the included provisions for binding individual arbitration rather than jury trials or class actions), under which service will auto-renew monthly until cancelled.", "url": "/idpassets/archive-legal/fragment/legal/prod/lpc/terms/consumerServiceAgreement/v38/consumerServiceAgreement.cmsfeed.js" }, { "type": "MRC_GEN", "version": "v1", "title": "Service Disclosures & Consent", "text": "By checking this box, you agree that the service(s) you have selected will automatically renew each month based on the rates in effect at the time of renewal, minus any discounts or promotions you qualify for (currently the rate shown on the screen). This will continue until you cancel the service. To avoid further charges, cancel before the end of your monthly billing cycle by visiting att.com/cancel-info or calling 1-800-288-2020.", "url": "/msapi/sales/termsandconditions/v1/termscontent/MRC_GEN" } ] }, { "type": "fulfillmentOptions", "fulfillmentOptions": [ { "id": "83c8f5a0-d210-4c2c-a7a2-35e27ec193a3", "shipmentDates": { "fromDate": "2026-09-02", "toDate": "2026-09-04" }, "deliveryDates": { "fromDate": "2026-09-03", "toDate": "2026-09-07" }, "deliveryMethod": "Standard Shipping", "fulfillmentMethod": "DF" } ] } ] } ], "isIncompatibleDevice": false } } } } } } }, "404": { "description": "Not Found" } } } }, "/productoffermanagementms/v1/product/submitchange": { "post": { "tags": [ "SubmitChangeRestitutionResource" ], "summary": "submitchange", "description": "This endpoint submits the changes requested by customer", "operationId": "submitChange_1", "requestBody": { "description": "SubmitChangeRequest", "content": { "application/json": { "schema": { "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Request Failure" }, "404": { "description": "Service URI Not Found" } } } }, "/productoffermanagementms/v4/product/submit": { "post": { "tags": [ "SubmitV4Resource" ], "summary": "submit", "description": "This endpoint submits the changes requested by customer", "operationId": "submit", "requestBody": { "description": "SubmitRequest", "content": { "application/json": { "schema": { "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Request Failure" }, "404": { "description": "Service URI Not Found" } } } } }, "components": { "schemas": { "AbpIntent": { "type": "object", "properties": { "autoPayOptIn": { "type": "boolean", "description": "autoPayOptIn" }, "tenderType": { "type": "string", "description": "tenderType" }, "paperlessBilling": { "type": "boolean", "description": "paperlessBilling" }, "cobrandedIndicator": { "type": "boolean", "description": "cobrandedIndicator" } }, "description": "Abp promotion intent" }, "AddOnInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "Product ID" }, "soc": { "type": "string", "description": "soc" }, "subscriberList": { "type": "array", "description": "List of Subscribers", "items": { "$ref": "#/components/schemas/SubscriberInfo" } }, "action": { "type": "string", "description": "action reason" }, "quantity": { "type": "integer", "description": "number of quantity", "format": "int64" }, "parentId": { "type": "string", "description": "Parent ID of the Coverage" }, "reasonCode": { "type": "string" }, "requestedDate": { "type": "string" } }, "description": "addOnInfo" }, "BackDateReason": { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" } } }, "BillingAccountCharacteristic": { "type": "object", "properties": { "name": { "type": "string", "description": "Characteristic name (autopayIntent, presentationMediaIntent, tenderType, providerType)", "example": "tenderType" }, "value": { "type": "string", "description": "Characteristic value", "example": "DebitCard" } }, "description": "Billing account characteristics — carries ABP enrollment values for SARA plus IND channel" }, "BillingAccountRequest": { "type": "object", "properties": { "characteristic": { "type": "array", "description": "Billing account characteristics — carries ABP enrollment values for SARA plus IND channel", "items": { "$ref": "#/components/schemas/BillingAccountCharacteristic" } } }, "description": "Billing account from SARA plus IND channel CRP request — carries ABP enrollment characteristics" }, "Channel": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "extensions": { "type": "array", "items": { "$ref": "#/components/schemas/Extension" } } }, "description": "channel" }, "Characteristics": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "description": "Product Characteristics" }, "CrossSellAccount": { "type": "object", "properties": { "accountNumber": { "type": "string", "description": "Value will be active Account Id. (e.g. 177066615725)", "example": "177066615725" }, "accountType": { "type": "string", "description": "Valid Values are : Uverse, Wireless", "example": "Wireless" } } }, "EffectiveDateOptions": { "type": "object", "properties": { "futureDate": { "type": "string" }, "backDate": { "type": "string" }, "currentDate": { "type": "string" }, "backDateReason": { "$ref": "#/components/schemas/BackDateReason" } } }, "Extension": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "MessageDetails": { "type": "object", "properties": { "messageType": { "type": "string", "description": "messageType" }, "featureNoteKey": { "type": "string", "description": "featureNoteKey" }, "featureNoteType": { "type": "string", "description": "featureNoteType" } }, "description": "MessageDetails" }, "MobileNumberChange": { "type": "object", "properties": { "reasonCode": { "type": "string", "description": "Reason Code", "example": "CR" }, "ppuState": { "type": "string", "description": "PPU State", "example": "Ohio" }, "ppuZip": { "type": "string", "description": "PPU Zip", "example": "97221" }, "zip": { "type": "string", "description": "Zip", "example": "97221" }, "city": { "type": "string", "description": "City", "example": "Denton" }, "state": { "type": "string", "description": "State", "example": "Ohio" }, "npa": { "type": "string", "description": "npa", "example": "npa" }, "nxx": { "type": "string", "description": "nxx", "example": "nxx" }, "wildCardSearch": { "type": "string", "description": "wildChars", "example": "96032" }, "noOfCtnsRequested": { "type": "integer", "description": "Number of CTNs requested for MNC", "format": "int32", "example": 10 }, "county": { "type": "string", "description": "County", "example": "Collin" }, "nciInd": { "type": "boolean", "description": "NCI Indicator", "example": false }, "portPath": { "type": "string", "description": "Port Path", "example": "PI" } } }, "PricePlanInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "Product ID" }, "action": { "type": "string", "description": "Action" } }, "description": "pricePlanInfo" }, "Product": { "type": "object", "properties": { "id": { "type": "string", "description": "Product ID" }, "characteristics": { "type": "array", "description": "Product Characteristics", "items": { "$ref": "#/components/schemas/Characteristics" } } }, "description": "Product" }, "ProductAvailabilityRequest": { "required": [ "ban", "intent" ], "type": "object", "properties": { "ban": { "type": "string", "description": "Account Number of the customer", "example": "177066615725" }, "accountNumber": { "type": "string" }, "productType": { "type": "string" }, "mode": { "type": "string" }, "intent": { "type": "string", "description": "intent" }, "guaranteeType": { "type": "string", "description": "guaranteeType" }, "removePromotionIds": { "type": "array", "description": "Promotion ids to be removed", "items": { "type": "string", "description": "Promotion ids to be removed" } }, "deviceId": { "type": "string", "description": "Current Device ID", "example": "65838021382177962" }, "requestedDate": { "type": "string" }, "reasonCode": { "type": "string" }, "autoBillPayIntent": { "type": "string" }, "requestedDevice": { "type": "string" }, "subscriberDetails": { "type": "array", "description": "Subscriber Data array is a list of subscriber. Numbers and its corresponding market and sub market. Required when the productType is set to Wireless.", "items": { "$ref": "#/components/schemas/SubscriberDetails" } }, "crossSellAccount": { "type": "array", "items": { "$ref": "#/components/schemas/CrossSellAccount" } }, "productOffering": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOffering" } }, "callIntent1": { "type": "string", "description": "call intent characteristic for TDATA", "example": "PCKG" }, "callIntent2": { "type": "string", "description": "call intent characteristic for TDATA", "example": "CHNG" }, "callIntent3": { "type": "string", "description": "call intent characteristic for TDATA", "example": "CHNG" }, "subscriberNumber": { "type": "string" }, "planWithAddOnsIntent": { "type": "boolean" }, "planOnlyIntent": { "type": "boolean" }, "optOut": { "type": "boolean" }, "optIn": { "type": "boolean" } } }, "ProductOffering": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "type": { "type": "string" }, "prodSpecCharValueUse": { "type": "array", "items": { "$ref": "#/components/schemas/ProdSpecCharValueUse" } } } }, "ReleaseSubscribersDetails": { "type": "object", "properties": { "market": { "type": "string" }, "subscriberNumbers": { "type": "array", "items": { "type": "string" } } } }, "SubscriberData": { "type": "object", "properties": { "subscriberNumber": { "type": "string", "description": "Subscriber Number (e.g. 9402083302)", "example": "9402083302" }, "market": { "type": "string", "description": "Market Code (e.g. DLS)", "example": "DLS" }, "submarket": { "type": "string", "description": "\tSub-market Code (e.g. DFW)", "example": "DFW" }, "selectedPlanCode": { "type": "string", "description": "Selected Plan Code (e.g. SDGUNMEM, SDGR9MSFM )", "example": "SDGUNMEM" }, "requestedDate": { "type": "string", "description": "Requested date", "example": "2025-02-10T00:00:00.000Z" }, "effectiveDateOptions": { "$ref": "#/components/schemas/EffectiveDateOptions" }, "imsi": { "type": "string" }, "eligiblePaymentModes": { "type": "array", "items": { "type": "string" } }, "linkedSuperPhoneCtn": { "type": "string" }, "pricePlanInfo": { "type": "array", "items": { "$ref": "#/components/schemas/PricePlanInfo" } }, "quantity": { "type": "integer", "format": "int32" } } }, "SubscriberInfo": { "type": "object", "properties": { "subscriberNumber": { "type": "string", "description": "Subscriber Number" }, "subscriberStatus": { "type": "string", "description": "Subscriber Status" }, "firstName": { "type": "string", "description": "First Name" }, "lastName": { "type": "string", "description": "Last Name" }, "inFocus": { "type": "boolean", "description": "inFocus", "enum": [ false ] }, "primary": { "type": "boolean", "description": "to check if the subscriber is a primary", "enum": [ false ] }, "neededForSubmit": { "type": "boolean", "description": "neededForSubmit", "enum": [ false ] }, "messageDetails": { "type": "array", "description": "List of Message Details", "items": { "$ref": "#/components/schemas/MessageDetails" } }, "ctn": { "type": "string", "description": "CTN" }, "displayable": { "type": "boolean" } }, "description": "SubscriberInfo" }, "UsageFeatures": { "type": "object", "properties": { "dataToggle": { "type": "boolean" }, "streamSaver": { "type": "boolean" } } }, "BillingAccount": { "type": "object", "properties": { "id": { "type": "string" }, "characteristic": { "type": "array", "items": { "$ref": "#/components/schemas/BillingCharacteristic" } } }, "description": "billingAccount" }, "BillingCharacteristic": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "CancellationSubscriberDetail": { "type": "object", "properties": { "subscriberNumber": { "type": "string", "description": "10-digit CTN to be cancelled/terminated as part of a Converged Connectivity downgrade" } }, "description": "List of CTN(s) to be terminated as part of a Converged Connectivity downgrade. Required only when phoneLineCount (Active+Suspended) > target plan's maxAllowedDevice_PHONE." }, "ChangePlanReviewRequest": { "type": "object", "properties": { "accountNumber": { "type": "string", "description": "Value will be active Account Id. (e.g. 177066615725)", "example": "177066615725" }, "productType": { "type": "string", "description": "Valid Values are : WIRELESS, BROADBAND", "example": "WIRELESS" }, "mode": { "type": "string", "description": "mode", "enum": [ "WirelessCRP, WirelessMNC, WirelessMNCPort, WirelessMNCRestore, UsageFeatures, ProductPurchase, SuspendRestore" ] }, "subscriberDetails": { "type": "array", "description": "Subscriber Data array is a list of subscriber. Numbers and its corresponding market and sub market. Required when the productType is set to Wireless.", "items": { "$ref": "#/components/schemas/SubscriberData" } }, "signatureReq": { "type": "string", "description": "Signature Req", "example": "Yes" }, "retrieveGroupDetails": { "type": "boolean", "description": "flag to retrieve the group details for the given subscriber", "example": false }, "retrieveOptionalDetails": { "type": "array", "description": "Attribute will accept a list of the optional downstream calls", "example": [ "catalogBEST" ], "items": { "type": "string", "description": "Attribute will accept a list of the optional downstream calls", "example": "catalogBEST" } }, "abpOverride": { "type": "string", "description": "abpOverride", "example": "Y" }, "ratingType": { "type": "string", "description": "postpaid/prepaid" }, "abpIntent": { "$ref": "#/components/schemas/AbpIntent" }, "intent": { "type": "string", "description": "planOnly/planWithAddons/EWCS/EWCSBooster/addInsuranceOnly" }, "channelInfo": { "$ref": "#/components/schemas/Channel" }, "wirelessCrpReviewRequest": { "$ref": "#/components/schemas/WirelessChangePlanReviewRequest" }, "productCancellationIntent": { "type": "string" }, "reasonCode": { "type": "string" }, "suspendRestoreIntent": { "type": "string", "description": "Valid values - Suspend , Restore" }, "effectiveDate": { "type": "string", "format": "date-time" }, "method": { "type": "string", "description": "getReview,updateReview" }, "deviceSwapIntent": { "type": "string", "description": "EWCS/WBB" }, "requestedDevice": { "type": "string", "description": "BBDevice/EWCS" }, "deviceId": { "type": "string", "description": "DeviceId" }, "immediatePromotionId": { "type": "array", "description": "immediatePromotionId", "items": { "type": "string", "description": "immediatePromotionId" } }, "cartId": { "type": "string", "description": "CartId - Passed for updateReview Method" }, "productOptions": { "$ref": "#/components/schemas/ProductOptions" }, "deliveryPlace": { "$ref": "#/components/schemas/DeliveryPlace" }, "requestedDate": { "type": "string", "description": "Requested Date in Product Purchase Review for Fulfillment Options" }, "autoRestoreReason": { "type": "string" }, "autoRestoreDate": { "type": "string", "description": "Date when service restoration should take place. i.e. 2022-12-01T00:00:00Z. Required when Intent = Suspend" }, "productPurchaseIntent": { "type": "string", "description": "EquipmentOnly" }, "autoBillPayIntent": { "type": "string", "description": "AutoBillPayIntent" }, "pricePlanInfo": { "type": "array", "description": "pricePlanInfo", "items": { "$ref": "#/components/schemas/PricePlanInfo" } }, "addOnInfo": { "type": "array", "description": "addOnInfo", "items": { "$ref": "#/components/schemas/AddOnInfo" } }, "managerOverride": { "type": "boolean" }, "addPromotionIds": { "type": "array", "description": "Promotion ids to add", "items": { "type": "string", "description": "Promotion ids to add" } }, "removePromotionIds": { "type": "array", "description": "Promotion ids to be removed", "items": { "type": "string", "description": "Promotion ids to be removed" } }, "generateDisclosure": { "type": "boolean" }, "retrieveDisclosure": { "type": "boolean" }, "actionType": { "type": "string" }, "crossSellAccount": { "type": "array", "items": { "$ref": "#/components/schemas/CrossSellAccountDetails" } }, "promotionsInfo": { "type": "array", "description": "promotionsInfo", "items": { "$ref": "#/components/schemas/PromotionsInfo" } }, "channel": { "$ref": "#/components/schemas/Channel" }, "billingAccount": { "$ref": "#/components/schemas/BillingAccount" }, "relatedParty": { "type": "array", "description": "relatedParty", "items": { "$ref": "#/components/schemas/RelatedParty" } }, "fanId": { "type": "string" }, "addRewardIds": { "type": "array", "items": { "type": "string" } }, "removeRewardIds": { "type": "array", "items": { "type": "string" } }, "rootBundleProductOfferId": { "type": "string" }, "newProductCode": { "type": "string" }, "currentProductCode": { "type": "string" }, "incomeVerificationId": { "type": "string" }, "market": { "type": "string" }, "flowType": { "type": "string" }, "transactionType": { "type": "string", "description": "Converged Connectivity CRP only. Valid values: 'Upgrade' or 'Downgrade'. Drives effective date selection and whether terminate items are sent to ShoppingCartMS." }, "cancellationSubscriberDetails": { "type": "array", "description": "List of CTN(s) to be terminated as part of a Converged Connectivity downgrade. Required only when phoneLineCount (Active+Suspended) > target plan's maxAllowedDevice_PHONE.", "items": { "$ref": "#/components/schemas/CancellationSubscriberDetail" } }, "isHboMaxEnabled": { "type": "boolean", "description": "When passed true, it API will invoke benefitDetails EP and check if hbomax eligibility for the customer. Default value is False", "example": false } }, "description": "Change Plan Review Request" }, "CrossSellAccountDetails": { "type": "object", "properties": { "accountNumber": { "type": "string", "description": "Account Number", "example": "553831024253" }, "accountType": { "type": "string", "description": "Account Type", "example": "Uverse" }, "activeProducts": { "type": "string", "description": "Active Products", "example": "HSIA,VOIP" }, "transportTypes": { "type": "string", "description": "Transport Types", "example": "FTTN,FTTN-BP" } }, "description": "CrossSell Account Details" }, "CurrentAndSelectedInfo": { "type": "object", "properties": { "selected": { "type": "string", "description": "Selected planType. For mix and match plans value is – MM For Group plans value is - LLP", "example": "MM" }, "current": { "type": "string", "description": "Current planType. For mix and match plans value-MM,For Group plans value-LLP,For Legacy value-MS ", "example": "MM" } }, "description": "Current And Selected Info for the plan type" }, "DeliveryPlace": { "type": "object", "properties": { "id": { "type": "string", "description": "Delivery Place ID used in Product Purchase Review for Fulfillment Options" }, "name": { "type": "string", "description": "Delivery Place Name used in Product Purchase Review for Fulfillment Options" }, "role": { "type": "string", "description": "Delivery Place Role used in Product Purchase Review for Fulfillment Options" } }, "description": "Delivery Place to be used in Product Purchase" }, "ProductCharacteristic": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "description": "selected product ProductCharacteristic" }, "ProductOptions": { "type": "object", "properties": { "fulfillmentId": { "type": "string", "description": "FulFillment ID selected will be passed in UpdateReview Method" }, "installationMethod": { "type": "string", "description": "installationMethod options" }, "appointmentId": { "type": "string", "description": "appointmentId of the selected appointment" }, "type": { "type": "string", "description": "appointment type(realTime/preferred) of the selected appointment" } }, "description": "Direct FulFillment -DF" }, "PromotionsInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "Promotion ID" }, "action": { "type": "string", "description": "action reason add/remove" } }, "description": "promotions" }, "RelatedParty": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "referredType": { "type": "string" }, "extensions": { "type": "array", "items": { "$ref": "#/components/schemas/Extension" } } }, "description": "relatedParty" }, "WirelessChangePlanReviewRequest": { "type": "object", "properties": { "accountNumber": { "type": "string", "description": "Value will be active Account Id. (e.g. 177066615725)", "example": "177066615725" }, "productType": { "type": "string", "description": "Valid Values are : WIRELESS, BROADBAND", "example": "WIRELESS" }, "mode": { "type": "string", "description": "mode", "enum": [ "WirelessCRP, WirelessMNC, WirelessMNCPort, WirelessMNCRestore, UsageFeatures, ProductPurchase, SuspendRestore" ] }, "subscriberDetails": { "type": "array", "description": "Subscriber Data array is a list of subscriber. Numbers and its corresponding market and sub market. Required when the productType is set to Wireless.", "items": { "$ref": "#/components/schemas/SubscriberData" } }, "signatureReq": { "type": "string", "description": "Signature Req", "example": "Yes" }, "retrieveGroupDetails": { "type": "boolean", "description": "flag to retrieve the group details for the given subscriber", "example": false }, "retrieveOptionalDetails": { "type": "array", "description": "Attribute will accept a list of the optional downstream calls", "example": [ "catalogBEST" ], "items": { "type": "string", "description": "Attribute will accept a list of the optional downstream calls", "example": "catalogBEST" } }, "abpOverride": { "type": "string", "description": "abpOverride", "example": "Y" }, "ratingType": { "type": "string", "description": "ratingType", "example": "postpaid" }, "abpIntent": { "$ref": "#/components/schemas/AbpIntent" }, "intent": { "type": "string", "description": "intent" }, "channelInfo": { "$ref": "#/components/schemas/Channel" }, "selectedPlanCode": { "type": "string", "description": "Selected Plan Code", "example": "SDGUNMSM" }, "planType": { "$ref": "#/components/schemas/CurrentAndSelectedInfo" }, "selectedDateOption": { "type": "string", "description": "Selected Date Option" }, "isHboMaxEnabled": { "type": "boolean", "description": "When passed true, it API will invoke benefitDetails EP and check if hbomax eligibility for the customer. Default value is False", "example": false } }, "description": "Wireless Change Plan Review Request" }, "BanInfo": { "type": "object", "properties": { "ban": { "type": "string", "description": "ban", "example": "177067470689" }, "market": { "type": "string", "description": "market", "example": "DLS" }, "submarket": { "type": "string", "description": "submarket", "example": "DFW" } }, "description": "BanInfo" }, "MobileSubscriberProfileInternalRequest": { "type": "object", "properties": { "subscriberNumber": { "type": "string" }, "banInfo": { "$ref": "#/components/schemas/BanInfo" } } }, "DeleteCacheData": { "type": "object", "properties": { "accountNumber": { "type": "string" }, "mode": { "type": "array", "items": { "type": "string" } }, "subscribers": { "type": "array", "items": { "type": "string" } }, "clearAll": { "type": "boolean" } } }, "DeleteCacheRequest": { "type": "object", "properties": { "deleteCacheData": { "type": "array", "items": { "$ref": "#/components/schemas/DeleteCacheData" } } }, "description": "DeleteCacheRequest" }, "BanPk": { "type": "object", "properties": { "mobileBan": { "type": "string" }, "market": { "type": "string" }, "submarket": { "type": "string" } } }, "FeatureDetailsTO": { "type": "object", "properties": { "featureCode": { "type": "string" }, "featureRevenueCode": { "type": "string" }, "generalLedgerRevenueCode": { "type": "string" } } }, "FeatureTO": { "type": "object", "properties": { "featureCode": { "type": "string" }, "soc": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" }, "expirationDate": { "type": "string", "format": "date-time" }, "featureSequenceNbr": { "type": "number", "format": "double" }, "dataUsageCategory": { "type": "string" }, "featureDesc": { "type": "string" }, "relSoc": { "type": "string" }, "serviceType": { "type": "string" }, "mpsFeatureCode": { "type": "string" }, "dupFtrAllowInd": { "type": "boolean" }, "parkInd": { "type": "boolean" }, "fmType": { "type": "string" }, "socEffectiveDate": { "type": "string" }, "socDetails": { "$ref": "#/components/schemas/SocDetailsTO" } } }, "MobileManageServicesRequest": { "type": "object", "properties": { "subscriberPk": { "$ref": "#/components/schemas/SubscriberPk" }, "confirmationIndicator": { "type": "boolean" }, "newSocList": { "type": "array", "items": { "$ref": "#/components/schemas/SocTO" } }, "removeSocList": { "type": "array", "items": { "$ref": "#/components/schemas/SocTO" } }, "mobileManageSvcsAction": { "type": "string", "enum": [ "RemMembFrmSDGNAddDataSoc", "RemMembFrmSDGNAddDataPlan", "RemMembFrmSDGNCreateNewSDG", "RemMembFrmSDGNAddMembToSDG", "SDGStopUsage", "SDGStartUsage", "LTEStopMeteredUsage", "LTEStartMeteredUsage", "RemNRAddSocNRExcludeNRIncludeFtrNRChgRatePlan", "ChangeSDG", "RemPendSDG", "ChangePendSDG", "ChangePendSDGEffDate" ] }, "recipientProfileList": { "type": "array", "items": { "$ref": "#/components/schemas/RecipientProfileTO" } } } }, "RecipientProfileTO": { "type": "object", "properties": { "firstName": { "type": "string", "description": "First Name" }, "lastName": { "type": "string", "description": "Last Name" }, "primarySubscriberNumber": { "type": "string", "description": "Primary Subscriber Number" }, "email": { "type": "string", "description": "Email" }, "language": { "type": "string", "description": "Language" }, "effectiveDate": { "type": "string", "description": "Effective Date" }, "planName": { "type": "string", "description": "Plan Name" }, "accountNumber": { "type": "string", "description": "Account Number" }, "postSaleInd": { "type": "string", "description": "Post Sale Indicator" }, "postSaleMsg": { "type": "string", "description": "Post Sale Message" }, "tncUrl": { "type": "string", "description": "Terms & Condition URL" }, "planType": { "type": "string", "description": "Plan Type" }, "cancelReason": { "type": "string", "description": "Cancel Reason" }, "last4": { "type": "string", "description": "Last4" }, "userId": { "type": "string", "description": "User Id" }, "smb": { "type": "boolean" } } }, "SocDetailsTO": { "type": "object", "properties": { "code": { "type": "string" }, "contractTermLength": { "type": "string" }, "price": { "type": "number", "format": "double" }, "socFamilyType": { "type": "string" }, "description": { "type": "string" }, "planId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "mrc": { "type": "string" }, "socType": { "type": "string" }, "socAction": { "type": "string" }, "childSoc": { "type": "string" }, "featureCode": { "type": "string" }, "groupPlanId": { "type": "string" }, "sdpIndicator": { "type": "boolean" }, "invalidIndicator": { "type": "boolean" }, "invalidReason": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" }, "expirationDate": { "type": "string", "format": "date-time" }, "featureDetailsList": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureDetailsTO" } }, "sequenceNumber": { "type": "integer", "format": "int32" }, "productCode": { "type": "string" }, "socpromotionList": { "type": "array", "items": { "type": "string" } } } }, "SocTO": { "type": "object", "properties": { "socCode": { "type": "string" }, "socCodeType": { "type": "string" }, "socCategory": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" }, "expirationDate": { "type": "string", "format": "date-time" }, "socSeqNbr": { "type": "number", "format": "double" }, "dealerCode": { "type": "string" }, "insuranceType": { "type": "string" }, "socMode": { "type": "string" }, "genAttribute": { "type": "string" }, "serviceType": { "type": "string" }, "rate": { "type": "number", "format": "double" }, "socDescription": { "type": "string" }, "features": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureTO" } }, "relSoc": { "type": "string" }, "category": { "type": "string" }, "cseInd": { "type": "boolean" }, "enablerInd": { "type": "boolean" }, "enablerOfferDesc": { "type": "string" }, "enablerOfferId": { "type": "integer", "format": "int32" }, "ftrSwitchCode": { "type": "string" }, "parkInd": { "type": "boolean" }, "socNetwork": { "type": "string" }, "dataGroupId": { "type": "string" }, "primarySdpIndicator": { "type": "boolean" }, "dataGroupInd": { "type": "string" }, "defaultSdp": { "type": "string" }, "dataUsageSocInd": { "type": "boolean" }, "offeringLevel": { "type": "string" }, "offeringNetworkType": { "type": "string" }, "splitLiabilityTargetBan": { "type": "string" }, "xmktEligInd": { "type": "string" }, "crossMarketIndicator": { "type": "boolean" }, "productType": { "type": "string" }, "productCode": { "type": "string" }, "rateWithDiscountForMS": { "type": "number", "format": "double" }, "getmSDiscount": { "type": "number", "format": "double" }, "valueMsPlanInd": { "type": "boolean" }, "includedData": { "type": "number", "format": "double" }, "action": { "type": "string" }, "socStatus": { "type": "string" }, "socExpirationDate": { "type": "string", "format": "date-time" }, "socRetirementGroupId": { "type": "string" }, "vqosSpecialParams": { "$ref": "#/components/schemas/VqosSpecialParamsTO" }, "actionCode": { "type": "string" }, "subscriptionClass": { "type": "string" }, "tier": { "type": "string" } } }, "SubscriberPk": { "type": "object", "properties": { "ctn": { "type": "string" }, "productType": { "type": "string" }, "banPk": { "$ref": "#/components/schemas/BanPk" }, "checkBanPK": { "type": "boolean" }, "unifiedInd": { "type": "boolean" }, "isReturnAdditionalDiscInfo": { "type": "boolean" } } }, "VqosSpecialParamsTO": { "type": "object", "properties": { "url": { "type": "string" }, "eid": { "type": "string" }, "label": { "type": "string" }, "soc": { "type": "string" }, "feature": { "type": "string" }, "socSeqNo": { "type": "string" }, "ocsFlag": { "type": "boolean" }, "apnName": { "type": "string" } } }, "ProdSpecCharValueUse": { "type": "object", "properties": { "name": { "type": "string" }, "valueType": { "type": "string" }, "productSpecCharacteristicValue": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSpecCharacteristicValue" } } } }, "ProductSpecCharacteristicValue": { "type": "object", "properties": { "value": { "type": "object" }, "isDefault": { "type": "boolean" } } }, "SubscriberDetails": { "type": "object", "properties": { "subscriberNumber": { "type": "string" }, "market": { "type": "string" }, "subMarket": { "type": "string", "description": "\tSub-market Code (e.g. DFW)", "example": "DFW" }, "selectedPlanCode": { "type": "string", "description": "Selected Plan Code (e.g. SDGUNMEM, SDGR9MSFM )", "example": "SDGUNMEM" } }, "description": "Subscriber Data array is a list of subscriber. Numbers and its corresponding market and sub market. Required when the productType is set to Wireless." }, "ProductReviewRequest": { "required": [ "accountNumber", "ban", "intent", "mode", "productType" ], "type": "object", "properties": { "ban": { "type": "string", "description": "Account Number of the customer", "example": "177066615725" }, "accountNumber": { "type": "string", "description": "Account Number of the customer", "example": "177066615725" }, "productType": { "type": "string", "description": "Valid values are: WIRELESS", "example": "WIRELESS" }, "mode": { "type": "string", "description": "mode" }, "intent": { "type": "string", "description": "intent" }, "guaranteeType": { "type": "string", "description": "guaranteeType" }, "method": { "type": "string", "description": "getReview,updateReview" }, "reasonCode": { "type": "string" }, "deliveryPlace": { "$ref": "#/components/schemas/DeliveryPlace" }, "cartId": { "type": "string", "description": "CartId - Passed for updateReview Method" }, "deviceId": { "type": "string", "description": "deviceId - Passed for getReview Method" }, "productOptions": { "$ref": "#/components/schemas/ProductOptions" }, "crossSellAccount": { "type": "array", "items": { "$ref": "#/components/schemas/CrossSellAccountDetails" } }, "pricePlanInfo": { "type": "array", "description": "pricePlanInfo", "items": { "$ref": "#/components/schemas/PricePlanInfo" } }, "addPromotionIds": { "type": "array", "description": "Promotion ids to add", "items": { "type": "string", "description": "Promotion ids to add" } }, "removePromotionIds": { "type": "array", "description": "Promotion ids to be removed", "items": { "type": "string", "description": "Promotion ids to be removed" } }, "immediatePromotionId": { "type": "array", "description": "immediatePromotionId", "items": { "type": "string", "description": "immediatePromotionId" } }, "addOnInfo": { "type": "array", "description": "addOnInfo", "items": { "$ref": "#/components/schemas/AddOnInfo" } }, "addRewardIds": { "type": "array", "description": "addRewardIds", "items": { "type": "string", "description": "addRewardIds" } }, "generateDisclosure": { "type": "boolean", "description": "generateDisclosure" }, "tenderType": { "type": "array", "description": "tenderType", "items": { "type": "string", "description": "tenderType" } }, "retrieveDisclosure": { "type": "boolean", "description": "retrieveDisclosure" }, "promotions": { "type": "array", "description": "promotions", "items": { "$ref": "#/components/schemas/PromotionsInfo" } }, "requestedDate": { "type": "string", "description": "requestedDate" }, "callIntent1": { "type": "string", "description": "call intent characteristic for TDATA", "example": "PCKG" }, "callIntent2": { "type": "string", "description": "call intent characteristic for TDATA", "example": "CHNG" }, "callIntent3": { "type": "string", "description": "call intent characteristic for TDATA", "example": "CHNG" } } } } } }