Get plan information of a sub account that is managed by a master account.
This API can only be used by master accounts that pay all billiing charges of their associated Pro or higher sub accounts. Zoom allows only to use master APIs and manage sub accounts' billing information. Email the partner programs team at for more details.
Scopes: billing:master
: Medium
643 matches
60 actions
Zoom
60 actions
- Get a channelGETv1.0.0
- Get a channelGETv1.0.0
- Get a group's settingsGETv1.0.0
- Get a shared line groupGETv1.0.0
- Get billing informationGETv1.0.0
- Get blocked list detailsGETv1.0.0
- Get call details from call logGETv1.0.0
- Get call QoSGETv1.0.0
- Get call queue detailsGETv1.0.0
- Get call queue recordingsGETv1.0.0
- Get common area phone detailsGETv1.0.0
- Get CRC port usageGETv1.0.0
- Get device detailsGETv1.0.0
- Get IM metricsGETv1.0.0
- Get invoice detailsGETv1.0.0
- Get issues of Zoom RoomsGETv1.0.0
- Get live stream detailsGETv1.0.0
- Get location settingsGETv1.0.0
- Get locked settingsGETv1.0.0
- Get locked settingsGETv1.0.0
- Get managed domainsGETv1.0.0
- Get meeting detailsGETv1.0.0
- Get meeting participant QoSGETv1.0.0
- Get operation logs reportGETv1.0.0
- Get phone number detailsGETv1.0.0
- Get phone site detailsGETv1.0.0
- Get plan InformationGETv1.0.0
- Get plan usageGETv1.0.0
- Get role informationGETv1.0.0
- Get setting template detailsGETv1.0.0
- Get settingsGETv1.0.0
- Get sharing/recording detailsGETv1.0.0
- Get sharing/recording detailsGETv1.0.0
- Get sub account detailsGETv1.0.0
- Get top 25 issues of Zoom RoomsGETv1.0.0
- Get top 25 Zoom Rooms with issuesGETv1.0.0
- Get trusted domainsGETv1.0.0
- Get user's contact detailsGETv1.0.0
- Get webinar detailsGETv1.0.0
- Get webinar participant QoSGETv1.0.0
- Get webinar participantsGETv1.0.0
- Get webinar tracking sourcesGETv1.0.0
- Get zoom meetings client feedbackGETv1.0.0
- Get Zoom Room account profileGETv1.0.0
- Get Zoom Room account settingsGETv1.0.0
- Get Zoom Room location profileGETv1.0.0
- Get Zoom Room location structureGETv1.0.0
- Get Zoom Rooms detailsGETv1.0.0
- List billing invoicesGETv1.0.0
- List H.323/SIP devicesGETv1.0.0
- List meeting participantsGETv1.0.0
- List meeting participants QoSGETv1.0.0
- List recordings of an accountGETv1.0.0
- List sub accountsGETv1.0.0
- List user's channelsGETv1.0.0
- List user's contactsGETv1.0.0
- List webinar participant QoSGETv1.0.0
- List webinarsGETv1.0.0
- List Zoom meetings client feedbackGETv1.0.0
- List Zoom RoomsGETv1.0.0
Communication/Zoom
Get plan Information
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
{
"type": "object",
"properties": {
"accountId": {
"type": "string"
}
},
"required": [
"accountId"
],
"additionalProperties": false
}Output
- 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
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
- 245
- 246
- 247
- 248
- 249
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 258
- 259
- 260
- 261
- 262
- 263
- 264
- 265
- 266
- 267
- 268
- 269
- 270
- 271
- 272
- 273
- 274
- 275
- 276
- 277
- 278
- 279
- 280
- 281
- 282
- 283
- 284
- 285
- 286
- 287
- 288
- 289
- 290
- 291
- 292
- 293
- 294
- 295
- 296
- 297
- 298
- 299
- 300
- 301
- 302
- 303
- 304
- 305
- 306
- 307
- 308
- 309
- 310
- 311
- 312
- 313
- 314
- 315
- 316
- 317
- 318
- 319
- 320
- 321
- 322
- 323
- 324
- 325
- 326
- 327
- 328
- 329
{
"type": "object",
"properties": {
"plan_audio": {
"type": "object",
"description": "Additional audio conferencing <a href=\"https://marketplace.zoom.us/docs/api-reference/other-references/plans#audio-conferencing-plans\">plan type.</a>",
"properties": {
"callout_countries": {
"type": "string",
"description": "Call-out countries: multiple values should separated by commas. For a list of allowed values, refer to the \"ID\" field in [this](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#tsp-call-out-countries) table."
},
"ddi_numbers": {
"type": "integer",
"description": "Dedicated dial-In numbers."
},
"next_invoice_date": {
"type": "string",
"description": "Next invoice date for the plan."
},
"premium_countries": {
"type": "string",
"description": "Premium countries: multiple values should be separated by commas. For a list of allowed values, refer to the \"ID\" field in the [Premium Countries](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#premium-countries) table."
},
"service_effective_date": {
"type": "string",
"description": "Date at which the plan became effective on the account."
},
"status": {
"type": "string",
"description": "Status of the plan.",
"enum": [
"active",
"cancel",
"expired"
]
},
"tollfree_countries": {
"type": "string",
"description": "Toll-free countries: multiple values should separated by a comma. For a list of allowed values, refer to the \"ID\" field in the [Toll Free Countries](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#toll-free-countries) table."
},
"type": {
"type": "string",
"description": "Additional audio conferencing <a href=\"/api-reference/other-references/plans\">plan type.</a>"
}
}
},
"plan_base": {
"type": "object",
"properties": {
"hosts": {
"type": "integer",
"description": "Account base plan number of hosts. For a Pro Plan please select a value between 1 and 9. For a Business Plan please select a value between 10 and 49. For a Education Plan please select a value between 20 and 149. For a Free Trial Plan please select a value between 1 and 9999."
},
"next_invoice_date": {
"type": "string",
"description": "Next invoice date for the plan."
},
"service_effective_date": {
"type": "string",
"description": "Date at which the plan became effective on the account."
},
"status": {
"type": "string",
"description": "Status of the plan.",
"enum": [
"active",
"cancel",
"expired"
]
},
"type": {
"type": "string",
"description": "Account base <a href=\"https://marketplace.zoom.us/docs/api-reference/other-references/plans\">plan type.</a>"
}
}
},
"plan_large_meeting": {
"type": "array",
"items": {
"type": "object",
"description": "Account plan object.",
"properties": {
"hosts": {
"type": "integer",
"description": "Account plan number of hosts."
},
"next_invoice_date": {
"type": "string",
"description": "Next invoice date for the plan."
},
"service_effective_date": {
"type": "string",
"description": "Date at which the plan became effective on the account."
},
"status": {
"type": "string",
"description": "Status of the plan.",
"enum": [
"active",
"cancel",
"expired"
]
},
"type": {
"type": "string",
"description": "Account <a href=\"https://marketplace.zoom.us/docs/api-reference/other-references/plans\">plan type.</a>"
}
}
}
},
"plan_phone": {
"type": "object",
"description": "Phone Plan Object",
"properties": {
"plan_base": {
"type": "object",
"description": "Additional phone base plans.",
"properties": {
"callout_countries": {
"type": "string",
"description": "Call-out countries: multiple values should separated by commas. For a list of allowed values, refer to the \"ID\" field in [this](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#tsp-call-out-countries) table."
},
"next_invoice_date": {
"type": "string",
"description": "Next invoice date for the plan."
},
"service_effective_date": {
"type": "string",
"description": "Date at which the plan became effective on the account."
},
"status": {
"type": "string",
"description": "Status of the plan.",
"enum": [
"active",
"cancel",
"expired"
]
},
"type": {
"type": "string",
"description": "Additional phone base <a href=\"https://marketplace.zoom.us/docs/api-reference/other-references/plans#additional-zoom-phone-plans\">plan type.</a>"
}
}
},
"plan_calling": {
"type": "array",
"description": "Additional phone calling plans.",
"items": {
"type": "object",
"properties": {
"hosts": {
"type": "integer"
},
"next_invoice_date": {
"type": "string",
"description": "Next invoice date for the plan."
},
"service_effective_date": {
"type": "string",
"description": "Date at which the plan became effective on the account."
},
"status": {
"type": "string",
"description": "Status of the plan.",
"enum": [
"active",
"cancel",
"expired"
]
},
"type": {
"type": "string",
"description": "Additional phone calling <a href=\"https://marketplace.zoom.us/docs/api-reference/other-references/plans#additional-zoom-phone-plans\">plan type.</a>"
}
}
}
},
"plan_number": {
"type": "array",
"description": "Additional phone number plans.",
"items": {
"type": "object",
"properties": {
"hosts": {
"type": "integer"
},
"next_invoice_date": {
"type": "string",
"description": "Next invoice date for the plan."
},
"service_effective_date": {
"type": "string",
"description": "Date at which the plan became effective on the account."
},
"status": {
"type": "string",
"description": "Status of the plan.",
"enum": [
"active",
"cancel",
"expired"
]
},
"type": {
"type": "string",
"description": "Additional phone number <a href=\"https://marketplace.zoom.us/docs/api-reference/other-references/plans#additional-zoom-phone-plans\">plan type.</a>"
}
}
}
}
}
},
"plan_recording": {
"type": "string",
"description": "Additional Cloud Recording plan."
},
"plan_recording_next_invoice_date": {
"type": "string",
"description": "Next invoice date of Additional Cloud Recording plan."
},
"plan_recording_service_effective_date": {
"type": "string",
"description": "Plan start date of Additional Cloud Recording plan."
},
"plan_recording_status": {
"type": "string",
"description": "Status of additional Cloud Recording plan.",
"enum": [
"Active",
"Cancelled"
]
},
"plan_room_connector": {
"type": "object",
"properties": {
"hosts": {
"type": "integer",
"description": "Account plan number of hosts."
},
"next_invoice_date": {
"type": "string",
"description": "Next invoice date for the plan."
},
"service_effective_date": {
"type": "string",
"description": "Date at which the plan became effective on the account."
},
"status": {
"type": "string",
"description": "Status of the plan.",
"enum": [
"active",
"cancel",
"expired"
]
},
"type": {
"type": "string",
"description": "Account <a href=\"https://marketplace.zoom.us/docs/api-reference/other-references/plans\">plan type.</a>"
}
}
},
"plan_webinar": {
"type": "array",
"items": {
"type": "object",
"description": "Account plan object.",
"properties": {
"hosts": {
"type": "integer",
"description": "Account plan number of hosts."
},
"next_invoice_date": {
"type": "string",
"description": "Next invoice date for the plan."
},
"service_effective_date": {
"type": "string",
"description": "Date at which the plan became effective on the account."
},
"status": {
"type": "string",
"description": "Status of the plan.",
"enum": [
"active",
"cancel",
"expired"
]
},
"type": {
"type": "string",
"description": "Account <a href=\"https://marketplace.zoom.us/docs/api-reference/other-references/plans\">plan type.</a>"
}
}
}
},
"plan_zoom_rooms": {
"type": "object",
"properties": {
"hosts": {
"type": "integer",
"description": "Account plan number of hosts."
},
"next_invoice_date": {
"type": "string",
"description": "Next invoice date for the plan."
},
"service_effective_date": {
"type": "string",
"description": "Date at which the plan became effective on the account."
},
"status": {
"type": "string",
"description": "Status of the plan.",
"enum": [
"active",
"cancel",
"expired"
]
},
"type": {
"type": "string",
"description": "Account <a href=\"https://marketplace.zoom.us/docs/api-reference/other-references/plans\">plan type.</a>"
}
}
}
}
}