Class: ZoomUs::Billing

Inherits:
Object
  • Object
show all
Defined in:
lib/zoom_us/billing.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ Billing

Returns a new instance of Billing.



19
20
21
 
# File 'lib/zoom_us/billing.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/zoom_us/billing.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#account_billing(account_id, opts = {}) ⇒ InlineResponse20014

Get Billing Information Get [billing information](support.zoom.us/hc/en-us/articles/201363263-About-Billing) of a Sub Account under a Master Account.
Prerequisites: * Pro or a higher paid account with Master Account option enabled.
Scope:‘billing:master`

Parameters:

  • account_id —

    The account ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InlineResponse20014) 


27
28
29
30
 
# File 'lib/zoom_us/billing.rb', line 27

def (, opts = {})
  data, _status_code, _headers = (, opts)
  data
end

#account_billing_update(account_id, body, opts = {}) ⇒ nil

Update Billing Information Update [billing information](support.zoom.us/hc/en-us/articles/201363263-About-Billing) for a Sub Account under a Master account. <aside>This is only for a paid sub account that is paid by a master account.</aside>
Prerequisites: * Pro or a higher paid account with Master Account option enabled.
Scope:‘billing:master`

Parameters:

  • account_id —

    The account ID.

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


82
83
84
85
 
# File 'lib/zoom_us/billing.rb', line 82

def (, body, opts = {})
  (, body, opts)
  nil
end

#account_billing_update_with_http_info(account_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update Billing Information Update [billing information](support.zoom.us/hc/en-us/articles/201363263-About-Billing) for a Sub Account under a Master account. &lt;aside&gt;This is only for a paid sub account that is paid by a master account.&lt;/aside&gt;&lt;br&gt;&lt;br&gt; Prerequisites: * Pro or a higher paid account with Master Account option enabled. &lt;br&gt; Scope:&#x60;billing:master&#x60;&lt;br&gt;

Parameters:

  • account_id —

    The account ID.

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/zoom_us/billing.rb', line 93

def (, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingApi.account_billing_update ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.account_billing_update"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling BillingApi.account_billing_update"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/billing'.sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#account_billing_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#account_billing_with_http_info(account_id, opts = {}) ⇒ Array<(InlineResponse20014, Fixnum, Hash)>

Get Billing Information Get [billing information](support.zoom.us/hc/en-us/articles/201363263-About-Billing) of a Sub Account under a Master Account.&lt;br&gt;&lt;br&gt; Prerequisites: * Pro or a higher paid account with Master Account option enabled. &lt;br&gt; Scope:&#x60;billing:master&#x60;&lt;br&gt;

Parameters:

  • account_id —

    The account ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20014, Fixnum, Hash)>) —

    InlineResponse20014 data, response status code and response headers



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
 
# File 'lib/zoom_us/billing.rb', line 37

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingApi.account_billing ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.account_billing"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/billing'.sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20014')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#account_billing\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#account_plan_addon_cancel(account_id, opts = {}) ⇒ nil

Cancel Additional Plans [Cancel additional plan](support.zoom.us/hc/en-us/articles/203634215-How-Do-I-Cancel-My-Subscription-) for a sub account. Only a Master account holder who pays for this sub account can cancel the add-on. The cancellation does not provide refund for the current subscription. The service remains active for the current session. Prerequisites:
* Pro or a higher plan with Master Account option enabled. * The Sub Account must be a paid account.
Scope: ‘billing:master`

Parameters:

  • account_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (Body49)

Returns:

  • (nil) 


141
142
143
144
 
# File 'lib/zoom_us/billing.rb', line 141

def (, opts = {})
  (, opts)
  nil
end

#account_plan_addon_cancel_with_http_info(account_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Cancel Additional Plans [Cancel additional plan](support.zoom.us/hc/en-us/articles/203634215-How-Do-I-Cancel-My-Subscription-) for a sub account. Only a Master account holder who pays for this sub account can cancel the add-on. The cancellation does not provide refund for the current subscription. The service remains active for the current session. Prerequisites:&lt;br&gt; * Pro or a higher plan with Master Account option enabled. * The Sub Account must be a paid account.&lt;br&gt; Scope: &#x60;billing:master&#x60;&lt;br&gt;

Parameters:

  • account_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (Body49)

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/zoom_us/billing.rb', line 152

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingApi.account_plan_addon_cancel ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.account_plan_addon_cancel"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/plans/addons/status'.sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#account_plan_addon_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#account_plan_addon_create(account_id, body, opts = {}) ⇒ nil

Add an Additional Plan Add an additional plan for a sub account.

Prerequisites:
* Pro or a higher plan with Master Account enabled. * The Sub Account must be a paid account. The billing charges for the Sub Account must be paid by the Master Account.
Scopes: ‘billing:master`

Parameters:

  • account_id —

    The account ID.

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


196
197
198
199
 
# File 'lib/zoom_us/billing.rb', line 196

def (, body, opts = {})
  (, body, opts)
  nil
end

#account_plan_addon_create_with_http_info(account_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Add an Additional Plan Add an additional plan for a sub account. &lt;br&gt; &lt;br&gt;Prerequisites:&lt;br&gt; * Pro or a higher plan with Master Account enabled. * The Sub Account must be a paid account. The billing charges for the Sub Account must be paid by the Master Account.&lt;br&gt; Scopes: &#x60;billing:master&#x60;&lt;br&gt;

Parameters:

  • account_id —

    The account ID.

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/zoom_us/billing.rb', line 207

def (, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingApi.account_plan_addon_create ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.account_plan_addon_create"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling BillingApi.account_plan_addon_create"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/plans/addons'.sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#account_plan_addon_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#account_plan_addon_update(account_id, body, opts = {}) ⇒ nil

Update an Additional Plan Update an additional plan for a sub account.

Prerequisites:
* Pro or a higher plan with Master Account enabled. * The Sub Account must be a paid account. The billing charges for the Sub Account must be paid by the Master Account.
Scopes: ‘billing:master`

Parameters:

  • account_id —

    The account ID.

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


255
256
257
258
 
# File 'lib/zoom_us/billing.rb', line 255

def (, body, opts = {})
  (, body, opts)
  nil
end

#account_plan_addon_update_with_http_info(account_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update an Additional Plan Update an additional plan for a sub account.&lt;br&gt; &lt;br&gt;Prerequisites:&lt;br&gt; * Pro or a higher plan with Master Account enabled. * The Sub Account must be a paid account. The billing charges for the Sub Account must be paid by the Master Account.&lt;br&gt; Scopes: &#x60;billing:master&#x60;&lt;br&gt;

Parameters:

  • account_id —

    The account ID.

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/zoom_us/billing.rb', line 266

def (, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingApi.account_plan_addon_update ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.account_plan_addon_update"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling BillingApi.account_plan_addon_update"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/plans/addons'.sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#account_plan_addon_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#account_plan_base_delete(account_id, opts = {}) ⇒ nil

Cancel Base Plan [Cancel a base plan](support.zoom.us/hc/en-us/articles/203634215-How-Do-I-Cancel-My-Subscription-) for a sub account. Only a master account holder who pays for this sub account can cancel the plan. The cancellation does not provide refund for the current subscription. The service remains active for the current session. Scopes: ‘billing:master`

Parameters:

  • account_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (Body48)

Returns:

  • (nil) 


314
315
316
317
 
# File 'lib/zoom_us/billing.rb', line 314

def (, opts = {})
  (, opts)
  nil
end

#account_plan_base_delete_with_http_info(account_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Cancel Base Plan [Cancel a base plan](support.zoom.us/hc/en-us/articles/203634215-How-Do-I-Cancel-My-Subscription-) for a sub account. Only a master account holder who pays for this sub account can cancel the plan. The cancellation does not provide refund for the current subscription. The service remains active for the current session. Scopes: &#x60;billing:master&#x60;&lt;br&gt;

Parameters:

  • account_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (Body48)

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/zoom_us/billing.rb', line 325

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingApi.account_plan_base_delete ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.account_plan_base_delete"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/plans/base/status'.sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#account_plan_base_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#account_plan_base_update(account_id, body, opts = {}) ⇒ nil

Update a Base Plan Update a base plan of a Sub Account. <aside> This can only update a base plan for a paid Sub Account that is paid by a Master Account.</aside>
Scopes: ‘billing:master`

Parameters:

  • account_id —

    The account ID.

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


369
370
371
372
 
# File 'lib/zoom_us/billing.rb', line 369

def (, body, opts = {})
  (, body, opts)
  nil
end

#account_plan_base_update_with_http_info(account_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update a Base Plan Update a base plan of a Sub Account. &lt;aside&gt; This can only update a base plan for a paid Sub Account that is paid by a Master Account.&lt;/aside&gt;&lt;br&gt;&lt;br&gt; Scopes: &#x60;billing:master&#x60;&lt;br&gt;

Parameters:

  • account_id —

    The account ID.

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/zoom_us/billing.rb', line 380

def (, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingApi.account_plan_base_update ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.account_plan_base_update"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling BillingApi.account_plan_base_update"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/plans/base'.sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#account_plan_base_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#account_plan_create(account_id, body, opts = {}) ⇒ nil

Subscribe to Plans Subscribe plans for a Sub Account under a Master Account. <aside> The plans can only be subscribed for an existing free Sub Account and the subscriptions charge should be paid by a Master Account.</aside>
Scopes: ‘billing:master`

Parameters:

  • account_id —

    The account ID.

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


428
429
430
431
 
# File 'lib/zoom_us/billing.rb', line 428

def (, body, opts = {})
  (, body, opts)
  nil
end

#account_plan_create_with_http_info(account_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Subscribe to Plans Subscribe plans for a Sub Account under a Master Account. &lt;aside&gt; The plans can only be subscribed for an existing free Sub Account and the subscriptions charge should be paid by a Master Account.&lt;/aside&gt;&lt;br&gt;&lt;br&gt; Scopes: &#x60;billing:master&#x60;&lt;br&gt;

Parameters:

  • account_id —

    The account ID.

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/zoom_us/billing.rb', line 439

def (, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingApi.account_plan_create ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.account_plan_create"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling BillingApi.account_plan_create"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/plans'.sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#account_plan_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#account_plans(account_id, opts = {}) ⇒ InlineResponse20015

Get Plan Information Get plan information for a Sub Account under the Master account. <aside> This is only for a Sub Account that is paid by a Master Account.</aside>
Scopes: ‘billing:master`

Parameters:

  • account_id —

    The account ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InlineResponse20015) 


486
487
488
489
 
# File 'lib/zoom_us/billing.rb', line 486

def (, opts = {})
  data, _status_code, _headers = (, opts)
  data
end

#account_plans_with_http_info(account_id, opts = {}) ⇒ Array<(InlineResponse20015, Fixnum, Hash)>

Get Plan Information Get plan information for a Sub Account under the Master account. &lt;aside&gt; This is only for a Sub Account that is paid by a Master Account.&lt;/aside&gt;&lt;br&gt;&lt;br&gt; Scopes: &#x60;billing:master&#x60;&lt;br&gt;

Parameters:

  • account_id —

    The account ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20015, Fixnum, Hash)>) —

    InlineResponse20015 data, response status code and response headers



496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/zoom_us/billing.rb', line 496

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingApi.account_plans ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.account_plans"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/plans'.sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20015')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#account_plans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_plan_usage(account_id, opts = {}) ⇒ InlineResponse20072

Get Plan Usage Get information on usage of [plans](marketplace.zoom.us/docs/api-reference/other-references/plans) on a Master Account. Prerequisite:
Account type: Master Account on a paid Pro, Business or Enterprise plan.
Scope: ‘billing:master`

Parameters:

  • account_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InlineResponse20072) 


540
541
542
543
 
# File 'lib/zoom_us/billing.rb', line 540

def get_plan_usage(, opts = {})
  data, _status_code, _headers = get_plan_usage_with_http_info(, opts)
  data
end

#get_plan_usage_with_http_info(account_id, opts = {}) ⇒ Array<(InlineResponse20072, Fixnum, Hash)>

Get Plan Usage Get information on usage of [plans](marketplace.zoom.us/docs/api-reference/other-references/plans) on a Master Account. Prerequisite:&lt;br&gt; Account type: Master Account on a paid Pro, Business or Enterprise plan.&lt;br&gt; Scope: &#x60;billing:master&#x60;&lt;br&gt;

Parameters:

  • account_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20072, Fixnum, Hash)>) —

    InlineResponse20072 data, response status code and response headers



550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
 
# File 'lib/zoom_us/billing.rb', line 550

def get_plan_usage_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BillingApi.get_plan_usage ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling BillingApi.get_plan_usage"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/plans/usage'.sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20072')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BillingApi#get_plan_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end