Examples Availability Retrieve Available Promotions
Scenario 1
1
ChangeRatePlan + Add EWCS
This API is used to retrieve the eligibility, available plans, and available addOns for a Broadband account performing a Change Rate Plan plus Add EWCS.
2
Request
1
2
3
4
5{
"accountNumber": "559210581033",
"productType": "BROADBAND",
"mode": "changeRatePlan",
}3
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191{
"content": {
"accountDetails": {
"ban": "559210581033"
},
"availableProducts": [
{
"eligibility": true,
"orderCount": 0,
"productDetails": [
{
"productType": "BB_Offer",
"productPrice": {
"base": 65.0,
"total": 55.0,
"uom": "month",
"taxIncluded": "EXCLUDED"
},
"productOriginalPrice": {
"base": 65.0,
"total": 55.0,
"uom": "month",
"taxIncluded": "EXCLUDED"
},
"productMarketingPrice": {
"base": 65.0,
"total": 55.0,
"uom": "month",
"taxIncluded": "EXCLUDED"
},
"productPriceRelationship": [
{
"type": "monthlyCharges",
"charges": [
{
"base": 65.0,
"total": 55.0,
"uom": "month",
"taxIncluded": "EXCLUDED"
}
]
}
],
"productOfferingRelationship": [
{
"type": "discounts",
"value": [
{
"id": "ImmediatePromotion_60d1c554-2c85-47ba-a79a-8f195115933d",
"name": "Price includes $10/mo. discount when you sign up for paperless billing and AutoPay with a debit card or bank account. Or $5/mo. with a credit card.",
"description": "Price includes $10/mo. discount when you sign up for paperless billing and AutoPay with a debit card or bank account. Or $5/mo. with a credit card.",
"applyPolicy": "automatic",
"productPrice": {
"base": 55.00,
"total": 10.00,
"uom": "month",
"taxIncluded": "EXCLUDED",
"promoType": "ABP"
}
}
]
},
{
"type": "BB_Plan",
"value": [
{
"id": "85333ec5-e9aa-4c8e-b886-04afb19e4a6a",
"name": "AT&T Internet 300",
"description": "300Mbps speed",
"productPrice": {
"base": 65.00,
"total": 55.00,
"uom": "month",
"taxIncluded": "EXCLUDED"
}
}
]
},
{
"type": "addon",
"value": [
{
"id": "b474f34f-5c2b-4501-99dd-28ef9e60dcff",
"name": "Fiber Wi-Fi Coverage Service",
"description": "Fiber Wi-Fi Coverage Service characteristics: From Benefits, update the characteristics from benefits",
"productOfferingType": "Coverage",
"productPrice": {
"base": 10.00,
"total": 10.00,
"uom": "month",
"taxIncluded": "EXCLUDED"
},
"equipments": [
{
"deviceId": "3be36e21-9fb4-4fe9-aaa8-fb2ebac818dc",
"deviceType": "Equipment",
"deviceTypeGroup": "BBDevice",
"deviceDisplayName": "All-Fi Fiber Booster",
"upperLimit": "5"
}
],
"currentProductIndicator": false
}
]
}
],
"benefits": "<ul><li>Game, stream, and video chat with confidence</li><li>Ensure your smart home devices run smoothly</li><li>300Mbps upload and download speeds</li></ul>",
"id": "b5d96af0-30bc-4988-92b9-7798cc9d4f93",
"productName": "AT&T Internet 300",
"productDescription": "300Mbps speed + unlimited internet data"
},
{
"productType": "BB_Offer",
"productPrice": {
"base": 75.0,
"total": 65.0,
"uom": "month",
"taxIncluded": "EXCLUDED"
},
"productOriginalPrice": {
"base": 75.0,
"total": 65.0,
"uom": "month",
"taxIncluded": "EXCLUDED"
},
"productMarketingPrice": {
"base": 75.0,
"total": 65.0,
"uom": "month",
"taxIncluded": "EXCLUDED"
},
"productPriceRelationship": [
{
"type": "monthlyCharges",
"charges": [
{
"base": 75.0,
"total": 65.0,
"uom": "month",
"taxIncluded": "EXCLUDED"
}
]
}
],
"productOfferingRelationship": [
{
"type": "discounts",
"value": [
{
"id": "ImmediatePromotion_33575693-7d6c-44b8-9319-9c54646d32f1",
"name": "Price includes $10/mo. discount when you sign up for paperless billing and AutoPay with a debit card or bank account. Or $5/mo. with a credit card.",
"description": "Price includes $10/mo. discount when you sign up for paperless billing and AutoPay with a debit card or bank account. Or $5/mo. with a credit card.",
"applyPolicy": "automatic",
"productPrice": {
"base": 65.00,
"total": 10.00,
"uom": "month",
"taxIncluded": "EXCLUDED",
"promoType": "ABP"
}
}
]
},
{
"type": "BB_Plan",
"value": [
{
"id": "49653ad3-9e89-466a-a13b-e57e6f6b82b5",
"name": "AT&T Internet 500",
"description": "500Mbps speed",
"productPrice": {
"base": 75.00,
"total": 65.00,
"uom": "month",
"taxIncluded": "EXCLUDED"
}
}
]
}
],
"benefits": "<ul><li>Connect and control multiple smart devices with ease</li><li>Perfect for gamers, streamers, and video-chatters</li><li>Fast 500Mbps upload and download speed</li></ul>",
"id": "e76cb4f2-032d-4bee-8ca2-f1726d1f23b9",
"productName": "AT&T Internet 500",
"productDescription": "500Mbps speed + unlimited internet data"
}
]
}
]
}
}
Scenario 2
1
ChangeRatePlan + Remove EWCS
This API is used to retrieve the eligibility, available plans, and available addOns for a Broadband account performing a Change Rate Plan plus Remove EWCS
2
Request
1
2
3
4
5
6{
"accountNumber": "559210581033",
"productType": "BROADBAND",
"mode": "changeRatePlan",
"reasonCode": "FTERM-QUAL"
}3
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201{
"content": {
"accountDetails": {
"ban": "559210581033"
},
"availableProducts": [
{
"eligibility": true,
"orderCount": 0,
"reasonCodePolicy": {
"reasonCodeAction": "Terminate",
"cancelImmediate": "Y",
"refund": "Y",
"feeToApply": "NRF",
"NRFDuration": "21",
"gracePeriodForNRF": "180",
"BREDuration": "14",
"BREEligible": "True"
},
"productDetails": [
{
"productType": "BB_Offer",
"productPrice": {
"base": 65.0,
"total": 55.0,
"uom": "month",
"taxIncluded": "EXCLUDED"
},
"productOriginalPrice": {
"base": 65.0,
"total": 55.0,
"uom": "month",
"taxIncluded": "EXCLUDED"
},
"productMarketingPrice": {
"base": 65.0,
"total": 55.0,
"uom": "month",
"taxIncluded": "EXCLUDED"
},
"productPriceRelationship": [
{
"type": "monthlyCharges",
"charges": [
{
"base": 65.0,
"total": 55.0,
"uom": "month",
"taxIncluded": "EXCLUDED"
}
]
}
],
"productOfferingRelationship": [
{
"type": "discounts",
"value": [
{
"id": "ImmediatePromotion_60d1c554-2c85-47ba-a79a-8f195115933d",
"name": "Price includes $10/mo. discount when you sign up for paperless billing and AutoPay with a debit card or bank account. Or $5/mo. with a credit card.",
"description": "Price includes $10/mo. discount when you sign up for paperless billing and AutoPay with a debit card or bank account. Or $5/mo. with a credit card.",
"applyPolicy": "automatic",
"productPrice": {
"base": 55.00,
"total": 10.00,
"uom": "month",
"taxIncluded": "EXCLUDED",
"promoType": "ABP"
}
}
]
},
{
"type": "BB_Plan",
"value": [
{
"id": "85333ec5-e9aa-4c8e-b886-04afb19e4a6a",
"name": "AT&T Internet 300",
"description": "300Mbps speed",
"productPrice": {
"base": 65.00,
"total": 55.00,
"uom": "month",
"taxIncluded": "EXCLUDED"
}
}
]
},
{
"type": "addon",
"value": [
{
"id": "b474f34f-5c2b-4501-99dd-28ef9e60dcff",
"name": "Fiber Wi-Fi Coverage Service",
"description": "Fiber Wi-Fi Coverage Service characteristics: From Benefits, update the characteristics from benefits",
"productOfferingType": "Coverage",
"productPrice": {
"base": 10.00,
"total": 10.00,
"uom": "month",
"taxIncluded": "EXCLUDED"
},
"equipments": [
{
"deviceId": "3be36e21-9fb4-4fe9-aaa8-fb2ebac818dc",
"deviceType": "Equipment",
"deviceTypeGroup": "BBDevice",
"deviceDisplayName": "All-Fi Fiber Booster",
"upperLimit": "5"
}
],
"currentProductIndicator": false
}
]
}
],
"benefits": "<ul><li>Game, stream, and video chat with confidence</li><li>Ensure your smart home devices run smoothly</li><li>300Mbps upload and download speeds</li></ul>",
"id": "b5d96af0-30bc-4988-92b9-7798cc9d4f93",
"productName": "AT&T Internet 300",
"productDescription": "300Mbps speed + unlimited internet data"
},
{
"productType": "BB_Offer",
"productPrice": {
"base": 75.0,
"total": 65.0,
"uom": "month",
"taxIncluded": "EXCLUDED"
},
"productOriginalPrice": {
"base": 75.0,
"total": 65.0,
"uom": "month",
"taxIncluded": "EXCLUDED"
},
"productMarketingPrice": {
"base": 75.0,
"total": 65.0,
"uom": "month",
"taxIncluded": "EXCLUDED"
},
"productPriceRelationship": [
{
"type": "monthlyCharges",
"charges": [
{
"base": 75.0,
"total": 65.0,
"uom": "month",
"taxIncluded": "EXCLUDED"
}
]
}
],
"productOfferingRelationship": [
{
"type": "discounts",
"value": [
{
"id": "ImmediatePromotion_33575693-7d6c-44b8-9319-9c54646d32f1",
"name": "Price includes $10/mo. discount when you sign up for paperless billing and AutoPay with a debit card or bank account. Or $5/mo. with a credit card.",
"description": "Price includes $10/mo. discount when you sign up for paperless billing and AutoPay with a debit card or bank account. Or $5/mo. with a credit card.",
"applyPolicy": "automatic",
"productPrice": {
"base": 65.00,
"total": 10.00,
"uom": "month",
"taxIncluded": "EXCLUDED",
"promoType": "ABP"
}
}
]
},
{
"type": "BB_Plan",
"value": [
{
"id": "49653ad3-9e89-466a-a13b-e57e6f6b82b5",
"name": "AT&T Internet 500",
"description": "500Mbps speed",
"productPrice": {
"base": 75.00,
"total": 65.00,
"uom": "month",
"taxIncluded": "EXCLUDED"
}
}
]
}
],
"benefits": "<ul><li>Connect and control multiple smart devices with ease</li><li>Perfect for gamers, streamers, and video-chatters</li><li>Fast 500Mbps upload and download speed</li></ul>",
"id": "e76cb4f2-032d-4bee-8ca2-f1726d1f23b9",
"productName": "AT&T Internet 500",
"productDescription": "500Mbps speed + unlimited internet data"
}
]
}
]
}
}