See this month's time on air

GET

/v1/live/usage

curl --request GET \
  --url https://api.iomza.com/v1/live/usage \
  --header 'Authorization: Bearer <token>'

• Production

Minutes on air this calendar month (UTC), across all your channels, against what your plan includes. Once they are used up, channels on air are stopped and refused until the next period.

Authorizations

• apiKey

Responses

200

The usage.

Media typeapplication/json

An organization’s time on air this calendar month, against what its plan includes.

object

object

required

string

Allowed value: live_usage

used_minutes

required

Minutes on air this calendar month (UTC), across the organization’s channels, deleted ones included.

number

limit_minutes

required

The minutes its plan includes per month; null: no limit. Once used up, channels on air are stopped and refused until the next period.

number | null

price_per_hour_usd

required

What an hour on air costs on its plan, in US dollars, from the balance; 0: nothing.

number

included_minutes

required

The minutes with a signal its plan includes per month, free of charge. What exceeds them is paid from topped-up balance.

number

included_used_minutes

required

Those used this month.

number

out_of_balance

required

No included time left and no balance: channels are refused until it is topped up.

boolean

period_start

required

When this period started.

string

period_end

required

When the next one starts.

string

Example

{
  "object": "live_usage"
}

401

The API key is missing, invalid or revoked.

Media typeapplication/json

object

error

required

object

code

required

Stable: branch on it.

string

Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

required

English, for people; may change.

string

details

required

Each problem, as path: message (validation errors).

Array<string>

Example

{
  "error": {
    "code": "validation_error"
  }
}

403

Valid credentials that may not do this (forbidden), your plan doesn’t include the module the route belongs to (module_not_in_plan), or your organization is suspended (organization_suspended).

Media typeapplication/json

object

error

required

object

code

required

Stable: branch on it.

string

Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

required

English, for people; may change.

string

details

required

Each problem, as path: message (validation errors).

Array<string>

Example

{
  "error": {
    "code": "validation_error"
  }
}

429

Too many requests: wait and retry. Answered by the gateway, so the body may differ.

Media typeapplication/json

object

error

required

object

code

required

Stable: branch on it.

string

Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

required

English, for people; may change.

string

details

required

Each problem, as path: message (validation errors).

Array<string>

Example

{
  "error": {
    "code": "validation_error"
  }
}

500

Ours: retry, and tell us if it persists.

Media typeapplication/json

object

error

required

object

code

required

Stable: branch on it.

string

Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

required

English, for people; may change.

string

details

required

Each problem, as path: message (validation errors).

Array<string>

Example

{
  "error": {
    "code": "validation_error"
  }
}

503

Momentarily unavailable: retry in a few seconds.

Media typeapplication/json

object

error

required

object

code

required

Stable: branch on it.

string

Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

required

English, for people; may change.

string

details

required

Each problem, as path: message (validation errors).

Array<string>

Example

{
  "error": {
    "code": "validation_error"
  }
}