GetEntitlementPlan
const url = 'https://example.com/api/v1/provision/consumer/me/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/plan';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/consumer/me/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/planParameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Responses
Section titled “Responses”OK
The plan context for an entitlement or session: what is applied, and what is available.
object
The plan a temporary override reverts to, while one is in force.
Why the temporary override is in force (self-service-signup-trial, payment-lapsed, …);
null when none is active. What tells a lapsed account apart from one on a trial.
A plan a consumer can see or switch to, and what it includes.
object
What the plan includes: one entry per feature it sets.
One feature’s value for the calling user: a fixed value, or a metered allowance.
object
The feature’s display name from the vendor’s catalog, for rendering; null when the server could not resolve the code, in which case the code is all there is to show.
The meter a metered feature reads, or null for a fixed value.
What the value is counted in (GB, seats, calls), from the vendor’s catalog; null when it names none.
SingleValue, TieredAbsolute, TieredPercentage, Denied or NotIncluded, as a stable name; the last two carry no value and no bands.
The value of a fixed feature — a flag, a count, a setting. Null for a metered one.
The bands a metered feature is enforced in, in ladder order. Empty for a fixed value.
One band of a metered feature’s ladder: where it starts and ends, and what the plan does there.
object
None, NotifyOnly, AllowWithGrace, AllowWithOverage, RateLimit,
Deny or SuspendUsage, as a stable name.
A plan a consumer can see or switch to, and what it includes.
object
What the plan includes: one entry per feature it sets.
One feature’s value for the calling user: a fixed value, or a metered allowance.
object
The feature’s display name from the vendor’s catalog, for rendering; null when the server could not resolve the code, in which case the code is all there is to show.
The meter a metered feature reads, or null for a fixed value.
What the value is counted in (GB, seats, calls), from the vendor’s catalog; null when it names none.
SingleValue, TieredAbsolute, TieredPercentage, Denied or NotIncluded, as a stable name; the last two carry no value and no bands.
The value of a fixed feature — a flag, a count, a setting. Null for a metered one.
The bands a metered feature is enforced in, in ladder order. Empty for a fixed value.
One band of a metered feature’s ladder: where it starts and ends, and what the plan does there.
object
None, NotifyOnly, AllowWithGrace, AllowWithOverage, RateLimit,
Deny or SuspendUsage, as a stable name.
What the holder is entitled to under the applied plan, add-on grants merged in and internal features left out — the values a license page renders.
One feature’s value for the calling user: a fixed value, or a metered allowance.
object
The feature’s display name from the vendor’s catalog, for rendering; null when the server could not resolve the code, in which case the code is all there is to show.
The meter a metered feature reads, or null for a fixed value.
What the value is counted in (GB, seats, calls), from the vendor’s catalog; null when it names none.
SingleValue, TieredAbsolute, TieredPercentage, Denied or NotIncluded, as a stable name; the last two carry no value and no bands.
The value of a fixed feature — a flag, a count, a setting. Null for a metered one.
The bands a metered feature is enforced in, in ladder order. Empty for a fixed value.
One band of a metered feature’s ladder: where it starts and ends, and what the plan does there.
object
None, NotifyOnly, AllowWithGrace, AllowWithOverage, RateLimit,
Deny or SuspendUsage, as a stable name.
The plan context for an entitlement or session: what is applied, and what is available.
object
The plan a temporary override reverts to, while one is in force.
Why the temporary override is in force (self-service-signup-trial, payment-lapsed, …);
null when none is active. What tells a lapsed account apart from one on a trial.
A plan a consumer can see or switch to, and what it includes.
object
What the plan includes: one entry per feature it sets.
One feature’s value for the calling user: a fixed value, or a metered allowance.
object
The feature’s display name from the vendor’s catalog, for rendering; null when the server could not resolve the code, in which case the code is all there is to show.
The meter a metered feature reads, or null for a fixed value.
What the value is counted in (GB, seats, calls), from the vendor’s catalog; null when it names none.
SingleValue, TieredAbsolute, TieredPercentage, Denied or NotIncluded, as a stable name; the last two carry no value and no bands.
The value of a fixed feature — a flag, a count, a setting. Null for a metered one.
The bands a metered feature is enforced in, in ladder order. Empty for a fixed value.
One band of a metered feature’s ladder: where it starts and ends, and what the plan does there.
object
None, NotifyOnly, AllowWithGrace, AllowWithOverage, RateLimit,
Deny or SuspendUsage, as a stable name.
A plan a consumer can see or switch to, and what it includes.
object
What the plan includes: one entry per feature it sets.
One feature’s value for the calling user: a fixed value, or a metered allowance.
object
The feature’s display name from the vendor’s catalog, for rendering; null when the server could not resolve the code, in which case the code is all there is to show.
The meter a metered feature reads, or null for a fixed value.
What the value is counted in (GB, seats, calls), from the vendor’s catalog; null when it names none.
SingleValue, TieredAbsolute, TieredPercentage, Denied or NotIncluded, as a stable name; the last two carry no value and no bands.
The value of a fixed feature — a flag, a count, a setting. Null for a metered one.
The bands a metered feature is enforced in, in ladder order. Empty for a fixed value.
One band of a metered feature’s ladder: where it starts and ends, and what the plan does there.
object
None, NotifyOnly, AllowWithGrace, AllowWithOverage, RateLimit,
Deny or SuspendUsage, as a stable name.
What the holder is entitled to under the applied plan, add-on grants merged in and internal features left out — the values a license page renders.
One feature’s value for the calling user: a fixed value, or a metered allowance.
object
The feature’s display name from the vendor’s catalog, for rendering; null when the server could not resolve the code, in which case the code is all there is to show.
The meter a metered feature reads, or null for a fixed value.
What the value is counted in (GB, seats, calls), from the vendor’s catalog; null when it names none.
SingleValue, TieredAbsolute, TieredPercentage, Denied or NotIncluded, as a stable name; the last two carry no value and no bands.
The value of a fixed feature — a flag, a count, a setting. Null for a metered one.
The bands a metered feature is enforced in, in ladder order. Empty for a fixed value.
One band of a metered feature’s ladder: where it starts and ends, and what the plan does there.
object
None, NotifyOnly, AllowWithGrace, AllowWithOverage, RateLimit,
Deny or SuspendUsage, as a stable name.
Examplegenerated
{ "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "assignedPlanName": "example", "overrideRevertPlanName": "example", "overrideReason": "example", "appliedPlan": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "description": "example", "sortOrder": 1, "featureValues": [ { "featureCode": "example", "featureName": "example", "metricName": "example", "units": "example", "enforcementType": "example", "value": "example", "bands": [ { "startUsage": 1, "endUsage": 1, "quotaUsagePolicy": "example" } ] } ] }, "availablePlans": [ { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "description": "example", "sortOrder": 1, "featureValues": [ { "featureCode": "example", "featureName": "example", "metricName": "example", "units": "example", "enforcementType": "example", "value": "example", "bands": [ { "startUsage": 1, "endUsage": 1, "quotaUsagePolicy": "example" } ] } ] } ], "effectiveFeatureValues": [ { "featureCode": "example", "featureName": "example", "metricName": "example", "units": "example", "enforcementType": "example", "value": "example", "bands": [ { "startUsage": 1, "endUsage": 1, "quotaUsagePolicy": "example" } ] } ]}The plan context for an entitlement or session: what is applied, and what is available.
object
The plan a temporary override reverts to, while one is in force.
Why the temporary override is in force (self-service-signup-trial, payment-lapsed, …);
null when none is active. What tells a lapsed account apart from one on a trial.
A plan a consumer can see or switch to, and what it includes.
object
What the plan includes: one entry per feature it sets.
One feature’s value for the calling user: a fixed value, or a metered allowance.
object
The feature’s display name from the vendor’s catalog, for rendering; null when the server could not resolve the code, in which case the code is all there is to show.
The meter a metered feature reads, or null for a fixed value.
What the value is counted in (GB, seats, calls), from the vendor’s catalog; null when it names none.
SingleValue, TieredAbsolute, TieredPercentage, Denied or NotIncluded, as a stable name; the last two carry no value and no bands.
The value of a fixed feature — a flag, a count, a setting. Null for a metered one.
The bands a metered feature is enforced in, in ladder order. Empty for a fixed value.
One band of a metered feature’s ladder: where it starts and ends, and what the plan does there.
object
None, NotifyOnly, AllowWithGrace, AllowWithOverage, RateLimit,
Deny or SuspendUsage, as a stable name.
A plan a consumer can see or switch to, and what it includes.
object
What the plan includes: one entry per feature it sets.
One feature’s value for the calling user: a fixed value, or a metered allowance.
object
The feature’s display name from the vendor’s catalog, for rendering; null when the server could not resolve the code, in which case the code is all there is to show.
The meter a metered feature reads, or null for a fixed value.
What the value is counted in (GB, seats, calls), from the vendor’s catalog; null when it names none.
SingleValue, TieredAbsolute, TieredPercentage, Denied or NotIncluded, as a stable name; the last two carry no value and no bands.
The value of a fixed feature — a flag, a count, a setting. Null for a metered one.
The bands a metered feature is enforced in, in ladder order. Empty for a fixed value.
One band of a metered feature’s ladder: where it starts and ends, and what the plan does there.
object
None, NotifyOnly, AllowWithGrace, AllowWithOverage, RateLimit,
Deny or SuspendUsage, as a stable name.
What the holder is entitled to under the applied plan, add-on grants merged in and internal features left out — the values a license page renders.
One feature’s value for the calling user: a fixed value, or a metered allowance.
object
The feature’s display name from the vendor’s catalog, for rendering; null when the server could not resolve the code, in which case the code is all there is to show.
The meter a metered feature reads, or null for a fixed value.
What the value is counted in (GB, seats, calls), from the vendor’s catalog; null when it names none.
SingleValue, TieredAbsolute, TieredPercentage, Denied or NotIncluded, as a stable name; the last two carry no value and no bands.
The value of a fixed feature — a flag, a count, a setting. Null for a metered one.
The bands a metered feature is enforced in, in ladder order. Empty for a fixed value.
One band of a metered feature’s ladder: where it starts and ends, and what the plan does there.
object
None, NotifyOnly, AllowWithGrace, AllowWithOverage, RateLimit,
Deny or SuspendUsage, as a stable name.
Examplegenerated
{ "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "assignedPlanName": "example", "overrideRevertPlanName": "example", "overrideReason": "example", "appliedPlan": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "description": "example", "sortOrder": 1, "featureValues": [ { "featureCode": "example", "featureName": "example", "metricName": "example", "units": "example", "enforcementType": "example", "value": "example", "bands": [ { "startUsage": 1, "endUsage": 1, "quotaUsagePolicy": "example" } ] } ] }, "availablePlans": [ { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "description": "example", "sortOrder": 1, "featureValues": [ { "featureCode": "example", "featureName": "example", "metricName": "example", "units": "example", "enforcementType": "example", "value": "example", "bands": [ { "startUsage": 1, "endUsage": 1, "quotaUsagePolicy": "example" } ] } ] } ], "effectiveFeatureValues": [ { "featureCode": "example", "featureName": "example", "metricName": "example", "units": "example", "enforcementType": "example", "value": "example", "bands": [ { "startUsage": 1, "endUsage": 1, "quotaUsagePolicy": "example" } ] } ]}Unauthorized
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"}Forbidden
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"}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"}Service Unavailable