Returns the consumption status on a metric for the given session, including quota.

GET

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

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

Parameters

Path Parameters

sessionId

required

string format: uuid

Active license session.

metric

required

string

Metric name.

Responses

200

OK

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

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

Example ^generated

{
  "tier": "example",
  "currentValue": 1,
  "start": 1,
  "limit": 1,
  "usagePercentage": 1,
  "quotaUsagePolicy": 1,
  "quotaUsageLevel": 1,
  "periodResetAt": "2026-04-15T12:00:00Z"
}

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

Example ^generated

{
  "tier": "example",
  "currentValue": 1,
  "start": 1,
  "limit": 1,
  "usagePercentage": 1,
  "quotaUsagePolicy": 1,
  "quotaUsageLevel": 1,
  "periodResetAt": "2026-04-15T12:00:00Z"
}

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"
}