Availability | Retrieve Available Promotions

Endpoint

POST
/msapi/productoffermanagementms/v3/product/availability

This API is designed to fetch the available plans and addons for change speed

arrowRequest

Header Parameters

                              Body Parameters

                              Responses

                              OK

                              arrowBody

                              application/json

                              REQUEST

                              1
                              2
                              3
                              4
                              5
                              6
                              7
                              8
                              9
                              10
                              11
                              12
                              curl --request POST \
                                   --url https://example.com/msapi/productoffermanagementms/v3/product/availability \
                                   --header 'accept: application/json' \
                                   --header 'authorization: Basic bTIzOTgwQGlkcC5hdHQuY29tOmlkcEs4c3J2Y3NBdXRoMjAyMW5wISE=' \
                                   --header 'content-type: application/json' \
                                   --data '
                              {
                                "accountNumber": "552321458441",
                                "productType": "BROADBAND",
                                "mode": "changeRatePlan"
                              }
                              '

                              RESPONSE

                              1
                              2
                              3
                              4
                              5
                              6
                              7
                              8
                              9
                              10
                              11
                              12
                              13
                              14
                              15
                              16
                              17
                              18
                              19
                              20
                              21
                              22
                              23
                              24
                              25
                              26
                              27
                              28
                              29
                              30
                              31
                              32
                              33
                              34
                              35
                              36
                              37
                              38
                              39
                              40
                              41
                              42
                              43
                              44
                              45
                              46
                              47
                              48
                              49
                              50
                              51
                              52
                              53
                              54
                              55
                              56
                              57
                              58
                              59
                              60
                              61
                              62
                              63
                              64
                              65
                              66
                              67
                              68
                              69
                              70
                              71
                              72
                              73
                              74
                              75
                              76
                              77
                              78
                              79
                              80
                              81
                              82
                              83
                              84
                              85
                              86
                              87
                              88
                              89
                              90
                              91
                              92
                              93
                              94
                              95
                              {
                                "content": {
                                  "accountDetails": {
                                    "ban": "551178303774"
                                  },
                                  "availableProducts": [
                                    {
                                      "eligibility": true,
                                      "productDetails": [
                                        {
                                          "id": "47771008-b663-44ff-ace1-774bdff794af",
                                          "productType": "BB_Offer",
                                          "displayName": "TestOnly_5_Unlimited 5G WBB Bundle_150RC (Exclusive)",
                                          "description": "Unlimited 5G WBB Bundle.",
                                          "benefits": "<p><strong>5G</strong> provides higher speeds, better availability</p> <p><strong>1000Mbps</strong> speeds up to and unlimited data</p> <p>No contract</p> <p>Self-Installation With SmartHome Manager</p> <p>Stream with Ease; great for multiple devices and streaming</p> <p>$100 Visa Rewards Card included</p>",
                                          "productPriceRelationship": [
                                            {
                                              "type": "productPrice",
                                              "charges": [
                                                {
                                                  "base": 145,
                                                  "uom": "month"
                                                }
                                              ]
                                            },
                                            {
                                              "type": "productOriginalPrice",
                                              "charges": [
                                                {
                                                  "base": 145,
                                                  "uom": "month"
                                                }
                                              ]
                                            },
                                            {
                                              "type": "productMarketingPrice",
                                              "charges": [
                                                {
                                                  "base": 145,
                                                  "uom": "month"
                                                }
                                              ]
                                            }
                                          ],
                                          "productOfferingRelationship": [
                                            {
                                              "type": "BB_Plan",
                                              "value": [
                                                {
                                                  "id": "0a1bd87d-b077-4aee-be08-6db78c401c72",
                                                  "name": "TestOnly_5_Unlimited 5G WBB Plan_150RC",
                                                  "description": "Plan for 5G WBB",
                                                  "productPrice": {
                                                    "base": 145,
                                                    "uom": "month"
                                                  }
                                                }
                                              ]
                                            },
                                            {
                                              "type": "discounts",
                                              "value": [
                                                {
                                                  "id": "5e0faebe-2ac1-41cc-979b-1757fc86af14",
                                                  "name": "$5 off with AutoPay and Paperless Bill",
                                                  "description": "Includes $5/mo. AutoPay and paperless billing discount.",
                                                  "applyPolicy": "automatic",
                                                  "durationPolicy": [
                                                    {
                                                      "uom": "month",
                                                      "duration": 3
                                                    }
                                                  ],
                                                  "productPriceRelationship": {
                                                    "total": 5,
                                                    "uom": "month"
                                                  },
                                                  "characteristics": {
                                                    "validForStartDate": "2022-11-06T06:00:00Z",
                                                    "validForEndDate": "2033-12-26T12:59:39.898Z",
                                                    "isPromoRolledUp": false
                                                  },
                                                  "priority": "1",
                                                  "promotionGroupId": "57cedf7a-9ddc-4b37-8038-a298f8b52e0e",
                                                  "longDescription": "<p><b>Ends XX/XX/XXXX</b> $10 off Extended Wifi Coverage Service for 3 months when purchasing with new Internet Air</p>"
                                                }
                                              ]
                                            }
                                          ]
                                        }
                                      ]
                                    }
                                  ]
                                }
                              }