Returns a usage overview (per-metric consumption, period state) for the entitlement.
const url = 'https://example.com/api/v1/provision/admin/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/usage-overview';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/admin/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/usage-overviewParameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Entitlement id.
Responses
Section titled “Responses”OK
Admin read model that explains an entitlement’s effective usage configuration: the plan in effect, active add-on grants, and the per-feature value resolution.
object
Where the plan in effect comes from: "Assigned plan" or "Temporary override".
An add-on grant on an entitlement as returned by the admin API, denormalized with the add-on and suite display fields.
object
The suite this add-on overlays.
Display name of that suite.
Campaign the grant was made under, when it was part of one.
True when the grant is inside its start/expiry window and not revoked.
Per-feature value resolution inside an EntitlementUsageOverviewDto: the plan-provided value, the add-on-computed value, and which one won.
object
Value contributed by the plan in effect; null when the plan does not set this feature.
Value computed from the active add-on grants; null when no add-on touches this feature.
The value that actually applies to the entitlement after resolution.
True when string? EntitlementUsageOverviewFeatureDto.EffectiveValue came from the add-on computation rather than the plan.
Add-ons that contributed to the computed value.
Origin of string? EntitlementUsageOverviewFeatureDto.EffectiveValue: "Plan", "Add-on", "Add-on merged", or "None".
Admin read model that explains an entitlement’s effective usage configuration: the plan in effect, active add-on grants, and the per-feature value resolution.
object
Where the plan in effect comes from: "Assigned plan" or "Temporary override".
An add-on grant on an entitlement as returned by the admin API, denormalized with the add-on and suite display fields.
object
The suite this add-on overlays.
Display name of that suite.
Campaign the grant was made under, when it was part of one.
True when the grant is inside its start/expiry window and not revoked.
Per-feature value resolution inside an EntitlementUsageOverviewDto: the plan-provided value, the add-on-computed value, and which one won.
object
Value contributed by the plan in effect; null when the plan does not set this feature.
Value computed from the active add-on grants; null when no add-on touches this feature.
The value that actually applies to the entitlement after resolution.
True when string? EntitlementUsageOverviewFeatureDto.EffectiveValue came from the add-on computation rather than the plan.
Add-ons that contributed to the computed value.
Origin of string? EntitlementUsageOverviewFeatureDto.EffectiveValue: "Plan", "Add-on", "Add-on merged", or "None".
Example
{ "features": [ { "addOnComputedOperation": "Replace" } ]}Admin read model that explains an entitlement’s effective usage configuration: the plan in effect, active add-on grants, and the per-feature value resolution.
object
Where the plan in effect comes from: "Assigned plan" or "Temporary override".
An add-on grant on an entitlement as returned by the admin API, denormalized with the add-on and suite display fields.
object
The suite this add-on overlays.
Display name of that suite.
Campaign the grant was made under, when it was part of one.
True when the grant is inside its start/expiry window and not revoked.
Per-feature value resolution inside an EntitlementUsageOverviewDto: the plan-provided value, the add-on-computed value, and which one won.
object
Value contributed by the plan in effect; null when the plan does not set this feature.
Value computed from the active add-on grants; null when no add-on touches this feature.
The value that actually applies to the entitlement after resolution.
True when string? EntitlementUsageOverviewFeatureDto.EffectiveValue came from the add-on computation rather than the plan.
Add-ons that contributed to the computed value.
Origin of string? EntitlementUsageOverviewFeatureDto.EffectiveValue: "Plan", "Add-on", "Add-on merged", or "None".
Example
{ "features": [ { "addOnComputedOperation": "Replace" } ]}Not Found
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"}