Returns current usage on a metric for the given session.

GET

/api/v1/provision/usage/{sessionId}/{metric}/usage

curl --request GET \
  --url https://example.com/api/v1/provision/usage/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/example/usage

Parameters

Path Parameters

sessionId

required

string format: uuid

Active license session.

metric

required

string

Metric name.

Responses

200

OK

object

metricType

integer

value

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

meteredUsageStatus

One of:

null

null

object

object

tier

string

currentValue

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

start

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

limit

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

usagePercentage

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

quotaUsagePolicy

Defines the enforcement behavior applied by the resource controller or interceptor when a specific usage tier threshold is reached. Ordered from least to most restrictive.

integer

quotaUsageLevel

integer

periodResetAt

When the current consumption period rolls over (derived from the configured calendar period). Null if the metric has no period.

null | string format: date-time

balanceUsage

One of:

null

null

object

Consumer view of a prepaid credit balance (e.g. extra render credits).

object

name

string

unit

string

numberFormat

string

initialCreditAmount

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

totalCredits

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

creditsUsed

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

creditsLeft

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

cumulativeCreditsUsed

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

object

metricType

integer

value

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

meteredUsageStatus

One of:

null

null

object

object

tier

string

currentValue

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

start

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

limit

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

usagePercentage

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

quotaUsagePolicy

Defines the enforcement behavior applied by the resource controller or interceptor when a specific usage tier threshold is reached. Ordered from least to most restrictive.

integer

quotaUsageLevel

integer

periodResetAt

When the current consumption period rolls over (derived from the configured calendar period). Null if the metric has no period.

null | string format: date-time

balanceUsage

One of:

null

null

object

Consumer view of a prepaid credit balance (e.g. extra render credits).

object

name

string

unit

string

numberFormat

string

initialCreditAmount

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

totalCredits

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

creditsUsed

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

creditsLeft

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

cumulativeCreditsUsed

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

Example ^generated

{
  "metricType": 1,
  "value": 1,
  "meteredUsageStatus": {
    "tier": "example",
    "currentValue": 1,
    "start": 1,
    "limit": 1,
    "usagePercentage": 1,
    "quotaUsagePolicy": 1,
    "quotaUsageLevel": 1,
    "periodResetAt": "2026-04-15T12:00:00Z"
  },
  "balanceUsage": {
    "name": "example",
    "unit": "example",
    "numberFormat": "example",
    "initialCreditAmount": 1,
    "totalCredits": 1,
    "creditsUsed": 1,
    "creditsLeft": 1,
    "cumulativeCreditsUsed": 1
  }
}

object

metricType

integer

value

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

meteredUsageStatus

One of:

null

null

object

object

tier

string

currentValue

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

start

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

limit

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

usagePercentage

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

quotaUsagePolicy

Defines the enforcement behavior applied by the resource controller or interceptor when a specific usage tier threshold is reached. Ordered from least to most restrictive.

integer

quotaUsageLevel

integer

periodResetAt

When the current consumption period rolls over (derived from the configured calendar period). Null if the metric has no period.

null | string format: date-time

balanceUsage

One of:

null

null

object

Consumer view of a prepaid credit balance (e.g. extra render credits).

object

name

string

unit

string

numberFormat

string

initialCreditAmount

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

totalCredits

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

creditsUsed

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

creditsLeft

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

cumulativeCreditsUsed

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

Example ^generated

{
  "metricType": 1,
  "value": 1,
  "meteredUsageStatus": {
    "tier": "example",
    "currentValue": 1,
    "start": 1,
    "limit": 1,
    "usagePercentage": 1,
    "quotaUsagePolicy": 1,
    "quotaUsageLevel": 1,
    "periodResetAt": "2026-04-15T12:00:00Z"
  },
  "balanceUsage": {
    "name": "example",
    "unit": "example",
    "numberFormat": "example",
    "initialCreditAmount": 1,
    "totalCredits": 1,
    "creditsUsed": 1,
    "creditsLeft": 1,
    "cumulativeCreditsUsed": 1
  }
}

404

Not Found

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}