Returns the consumption status on a metric for the given session, including quota.
const url = 'https://example.com/api/v1/provision/usage/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/example/consumption';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/v1/provision/usage/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/example/consumptionA metric the entitlement does not track answers 204 with no body, and a session that no longer exists (deleted or revoked) answers 409 (license.no_active_session).
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Active license session.
Metric name.
Responses
Section titled “Responses”OK
Consumer view of where consumption currently sits within the metered usage tiers.
object
Name of the tier the current consumption falls into.
Lower bound of the current tier.
Upper bound of the current tier.
Consumption as a percentage (0–100) of the tier limit.
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.
Severity of consumption relative to the configured usage tiers.
When the window currently being consumed ends. Null when the metric has no period, and also while no window is open — a quota anchored on first use has no boundary until the report that starts one, and reporting a guess there would show a countdown to a reset that is not scheduled.
Credits taken from the tier’s funding balance for this call, or null when nothing was charged. On a refused call it is what the call would have cost — the number to put in front of someone who needs to top up.
How much of the amount you asked for fell past the included quota and was paid for out of the balance. Subtract it from your request to say how much was included: six seconds committed with one funded unit is “five seconds included, one second from your credits”.
Why a funded overage was refused. None unless the decision is a funding refusal.
Consumer view of where consumption currently sits within the metered usage tiers.
object
Name of the tier the current consumption falls into.
Lower bound of the current tier.
Upper bound of the current tier.
Consumption as a percentage (0–100) of the tier limit.
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.
Severity of consumption relative to the configured usage tiers.
When the window currently being consumed ends. Null when the metric has no period, and also while no window is open — a quota anchored on first use has no boundary until the report that starts one, and reporting a guess there would show a countdown to a reset that is not scheduled.
Credits taken from the tier’s funding balance for this call, or null when nothing was charged. On a refused call it is what the call would have cost — the number to put in front of someone who needs to top up.
How much of the amount you asked for fell past the included quota and was paid for out of the balance. Subtract it from your request to say how much was included: six seconds committed with one funded unit is “five seconds included, one second from your credits”.
Why a funded overage was refused. None unless the decision is a funding refusal.
Example
{ "quotaUsagePolicy": "None", "quotaUsageLevel": "None", "reason": "None"}Consumer view of where consumption currently sits within the metered usage tiers.
object
Name of the tier the current consumption falls into.
Lower bound of the current tier.
Upper bound of the current tier.
Consumption as a percentage (0–100) of the tier limit.
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.
Severity of consumption relative to the configured usage tiers.
When the window currently being consumed ends. Null when the metric has no period, and also while no window is open — a quota anchored on first use has no boundary until the report that starts one, and reporting a guess there would show a countdown to a reset that is not scheduled.
Credits taken from the tier’s funding balance for this call, or null when nothing was charged. On a refused call it is what the call would have cost — the number to put in front of someone who needs to top up.
How much of the amount you asked for fell past the included quota and was paid for out of the balance. Subtract it from your request to say how much was included: six seconds committed with one funded unit is “five seconds included, one second from your credits”.
Why a funded overage was refused. None unless the decision is a funding refusal.
Example
{ "quotaUsagePolicy": "None", "quotaUsageLevel": "None", "reason": "None"}No Content
Conflict
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}