NSns-api
Meetings/Iotum
Iotum

Create Iotum Video Subscription

Changed on

Create a Iotum video subscription to one of the available Iotum products for that company

post/domains/{domain}/video/subscription/{slug}

Request

  • Base URL
    https://ns-api.com/ns-api/v2
  • URL
    https://ns-api.com/ns-api/v2/domains/{domain}/video/subscription/{slug}
  • Auth
    HTTP bearer

Path parameters

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Example:example.com
slugstring required

Request body

switch-planboolean

If specified and set to the subscription ID of one of the company’s current plans, that plan will be canceled and used in to prorate the initial amount of the new plan (plan switching) If set to null, the current plan(s) of the company will not be canceled and instead the company will be subscribed to the provided plan in addition to their existing plan(s). When omitted (no key/value not present in the request body), the default behavior of switching the company’s current plan with the new plan will be applied.

host-limitinteger

A positive integer value that the new subscription’s host limit should be set to. When subscribing to a product that is using the per-host pricing method, the host_limit value provided will be multiplied by the per-host price of the product to determine and set the total amount of the monthly subscription charges.

Response

codeinteger required
messagestring required

Changes