Get plan Information

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 approved partners to use master APIs and manage sub accounts' billing information. Email the partner programs team at partner-success@zoom.us for more details.

Scopes: billing:master
Rate Limit Label: Medium

{ "plan_audio": { "callout_countries": "string", "ddi_numbers": "integer", "premium_countries": "string", "tollfree_countries": "string", "type": "string" }, "plan_base": { "hosts": "integer", "type": "string" }, "plan_large_meeting": [ { "hosts": "integer", "type": "string" } ], "plan_phone": { "plan_base": { "callout_countries": "string", "type": "string" }, "plan_calling": [ { "hosts": "integer", "type": "string" } ], "plan_number": [ { "hosts": "integer", "type": "string" } ] }, "plan_recording": "string", "plan_room_connector": { "hosts": "integer", "type": "string" }, "plan_webinar": [ { "hosts": "integer", "type": "string" } ], "plan_zoom_rooms": { "hosts": "integer", "type": "string" } }

返回响应

🟢200**HTTP Status Code:**`200`<br> Account's plans returned.

application/json

Body

plan_audio

object

可选

Additional audio conferencing plan type.

callout_countries

string

可选

Call-out countries: multiple values should separated by commas. For a list of allowed values, refer to the "ID" field in this table.

ddi_numbers

integer

可选

Dedicated dial-In numbers.

next_invoice_date

string

可选

Next invoice date for the plan.

premium_countries

string

可选

Premium countries: multiple values should be separated by commas. For a list of allowed values, refer to the "ID" field in the Premium Countries table.

service_effective_date

string

可选

Date at which the plan became effective on the account.

status

enum<string>

可选

Status of the plan.

枚举值:

activecancelexpired

tollfree_countries

string

可选

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 table.

type

string

可选

Additional audio conferencing plan type.

plan_base

object

可选

hosts

integer

可选

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

string

可选

Next invoice date for the plan.

service_effective_date

string

可选

Date at which the plan became effective on the account.

status

enum<string>

可选

Status of the plan.

枚举值:

activecancelexpired

type

string

可选

Account base plan type.

plan_large_meeting

array [object {5}]

可选

hosts

integer

可选

Account plan number of hosts.

next_invoice_date

string

可选

Next invoice date for the plan.

service_effective_date

string

可选

Date at which the plan became effective on the account.

status

enum<string>

可选

Status of the plan.

枚举值:

activecancelexpired

type

string

可选

Account plan type.

plan_phone

object

PhonePlan

可选

Phone Plan Object

plan_base

object

可选

Additional phone base plans.

plan_calling

array [object {5}]

可选

Additional phone calling plans.

plan_number

array [object {5}]

可选

Additional phone number plans.

plan_recording

string

可选

Additional Cloud Recording plan.

plan_recording_next_invoice_date

string

可选

Next invoice date of Additional Cloud Recording plan.

plan_recording_service_effective_date

string

可选

Plan start date of Additional Cloud Recording plan.

plan_recording_status

enum<string>

可选

Status of additional Cloud Recording plan.

枚举值:

ActiveCancelled

plan_room_connector

object

可选

hosts

integer

可选

Account plan number of hosts.

next_invoice_date

string

可选

Next invoice date for the plan.

service_effective_date

string

可选

Date at which the plan became effective on the account.

status

enum<string>

可选

Status of the plan.

枚举值:

activecancelexpired

type

string

可选

Account plan type.

plan_webinar

array [object {5}]

可选

hosts

integer

可选

Account plan number of hosts.

next_invoice_date

string

可选

Next invoice date for the plan.

service_effective_date

string

可选

Date at which the plan became effective on the account.

status

enum<string>

可选

Status of the plan.

枚举值:

activecancelexpired

type

string

可选

Account plan type.

plan_zoom_rooms

object

可选

hosts

integer

可选

Account plan number of hosts.

next_invoice_date

string

可选

Next invoice date for the plan.

service_effective_date

string

可选

Date at which the plan became effective on the account.

status

enum<string>

可选

Status of the plan.

枚举值:

activecancelexpired

type

string

可选

Account plan type.

🟠400**HTTP Status Code:** `400`<br> **Error Code:** `2100`<br> This sub account is on self pay mode.

🟠404**HTTP Status Code:**`404`<br> Account does not exist: {subAccountId}.

Get plan Information

请求参数

返回响应