Archives an add-on, which is final: it can't be granted again, and entitlements that hold it get none of its features.
const url = 'https://example.com/api/v1/provision/admin/usage-plans/add-ons/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/archive';const options = {method: 'POST'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/provision/admin/usage-plans/add-ons/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/archiveParameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Add-on id.
Responses
Section titled “Responses”OK
An add-on: a named set of feature adjustments, scoped to a suite, that can be granted to entitlements on top of their plan. Scoped to the suite rather than one of its plan-set revisions — revisions fork, the suite is what persists.
object
Lifecycle state of an add-on.
A feature definition in a product’s feature catalog: the canonical source for a feature code’s type, allowed values, metering, and visibility. Whether end users are asked to rate a feature is configured separately, per campaign — see RatingCampaignDto.
object
Metric name a Metered feature reports usage under.
Data type of a feature’s value; determines how Value strings are interpreted and enforced.
Lifecycle state of a feature catalog entry.
Who can see a feature.
Relative, unitless value weight used by value-delivered analytics. Null means the feature is not valued yet and contributes nothing. Weights are applied when a report is generated, so changing one re-values history — intended behaviour for a relative measure.
One allowed value of an Enumeration-typed feature.
object
Tag names applied to this entry, from the tenant’s TagScopeDto.FeatureCatalog vocabulary.
What still actively refers to the entry, and so keeps it from being deleted. Null where the read does not compute it.
object
Products that carry the feature.
Customer entitlements whose features include the code.
Offers whose features include the code.
Plan sets with a plan that sets a value for the code.
Add-ons that grant the feature.
Rating campaigns that ask about the feature.
One feature adjustment an add-on applies, and how it combines with the plan value.
object
Operand for the operation, as a string interpreted per the feature’s data type; unused for Tiered.
Usage tiers applied when AddOnFeatureValueOperationDto AddOnFeatureValueDto.Operation is Tiered.
Represents a tier of usage with associated credits and severity status.
object
Gets or sets the start usage for the tier.
Tier start as a percentage of the feature value (percentage-based enforcement).
Gets or sets the end usage for the tier. Nullable.
Tier end as a percentage of the feature value (percentage-based enforcement).
Gets or sets the flat fee credits for the tier.
Gets or sets the credits per unit of consumption for the tier.
Gets or sets the name of the usage tier.
Gets or sets the overage severity status for the tier.
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.
Metric name of the credit balance, on the same entitlement, that pays for consumption in this tier. Only meaningful on a tier whose policy is AllowWithOverage: name a balance and every unit past the tier’s start is priced and charged to it on commit, refusing the commit when it cannot be paid for; leave it empty and the overage is allowed and merely reported.
Plan names this adjustment applies to; empty applies it to every plan.
How an add-on’s feature value combines with the plan-provided value.
What refers to the add-on. Only a Draft add-on nothing refers to can be deleted; any other is archived. Null where the read does not compute it, such as a catalog export.
object
Customer entitlements granted the add-on, including grants since revoked or expired.
Offers that carry a grant of the add-on.
An add-on: a named set of feature adjustments, scoped to a suite, that can be granted to entitlements on top of their plan. Scoped to the suite rather than one of its plan-set revisions — revisions fork, the suite is what persists.
object
Lifecycle state of an add-on.
A feature definition in a product’s feature catalog: the canonical source for a feature code’s type, allowed values, metering, and visibility. Whether end users are asked to rate a feature is configured separately, per campaign — see RatingCampaignDto.
object
Metric name a Metered feature reports usage under.
Data type of a feature’s value; determines how Value strings are interpreted and enforced.
Lifecycle state of a feature catalog entry.
Who can see a feature.
Relative, unitless value weight used by value-delivered analytics. Null means the feature is not valued yet and contributes nothing. Weights are applied when a report is generated, so changing one re-values history — intended behaviour for a relative measure.
One allowed value of an Enumeration-typed feature.
object
Tag names applied to this entry, from the tenant’s TagScopeDto.FeatureCatalog vocabulary.
What still actively refers to the entry, and so keeps it from being deleted. Null where the read does not compute it.
object
Products that carry the feature.
Customer entitlements whose features include the code.
Offers whose features include the code.
Plan sets with a plan that sets a value for the code.
Add-ons that grant the feature.
Rating campaigns that ask about the feature.
One feature adjustment an add-on applies, and how it combines with the plan value.
object
Operand for the operation, as a string interpreted per the feature’s data type; unused for Tiered.
Usage tiers applied when AddOnFeatureValueOperationDto AddOnFeatureValueDto.Operation is Tiered.
Represents a tier of usage with associated credits and severity status.
object
Gets or sets the start usage for the tier.
Tier start as a percentage of the feature value (percentage-based enforcement).
Gets or sets the end usage for the tier. Nullable.
Tier end as a percentage of the feature value (percentage-based enforcement).
Gets or sets the flat fee credits for the tier.
Gets or sets the credits per unit of consumption for the tier.
Gets or sets the name of the usage tier.
Gets or sets the overage severity status for the tier.
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.
Metric name of the credit balance, on the same entitlement, that pays for consumption in this tier. Only meaningful on a tier whose policy is AllowWithOverage: name a balance and every unit past the tier’s start is priced and charged to it on commit, refusing the commit when it cannot be paid for; leave it empty and the overage is allowed and merely reported.
Plan names this adjustment applies to; empty applies it to every plan.
How an add-on’s feature value combines with the plan-provided value.
What refers to the add-on. Only a Draft add-on nothing refers to can be deleted; any other is archived. Null where the read does not compute it, such as a catalog export.
object
Customer entitlements granted the add-on, including grants since revoked or expired.
Offers that carry a grant of the add-on.
Example
{ "status": "Draft", "features": [ { "featureType": "Boolean", "lifecycleStatus": "Draft", "visibility": "Public", "meterAggregationType": "CumulativeCounter" } ], "featureValues": [ { "usageTiers": [ { "quotaUsageLevel": "None", "quotaUsagePolicy": "None" } ], "operation": "Replace" } ]}An add-on: a named set of feature adjustments, scoped to a suite, that can be granted to entitlements on top of their plan. Scoped to the suite rather than one of its plan-set revisions — revisions fork, the suite is what persists.
object
Lifecycle state of an add-on.
A feature definition in a product’s feature catalog: the canonical source for a feature code’s type, allowed values, metering, and visibility. Whether end users are asked to rate a feature is configured separately, per campaign — see RatingCampaignDto.
object
Metric name a Metered feature reports usage under.
Data type of a feature’s value; determines how Value strings are interpreted and enforced.
Lifecycle state of a feature catalog entry.
Who can see a feature.
Relative, unitless value weight used by value-delivered analytics. Null means the feature is not valued yet and contributes nothing. Weights are applied when a report is generated, so changing one re-values history — intended behaviour for a relative measure.
One allowed value of an Enumeration-typed feature.
object
Tag names applied to this entry, from the tenant’s TagScopeDto.FeatureCatalog vocabulary.
What still actively refers to the entry, and so keeps it from being deleted. Null where the read does not compute it.
object
Products that carry the feature.
Customer entitlements whose features include the code.
Offers whose features include the code.
Plan sets with a plan that sets a value for the code.
Add-ons that grant the feature.
Rating campaigns that ask about the feature.
One feature adjustment an add-on applies, and how it combines with the plan value.
object
Operand for the operation, as a string interpreted per the feature’s data type; unused for Tiered.
Usage tiers applied when AddOnFeatureValueOperationDto AddOnFeatureValueDto.Operation is Tiered.
Represents a tier of usage with associated credits and severity status.
object
Gets or sets the start usage for the tier.
Tier start as a percentage of the feature value (percentage-based enforcement).
Gets or sets the end usage for the tier. Nullable.
Tier end as a percentage of the feature value (percentage-based enforcement).
Gets or sets the flat fee credits for the tier.
Gets or sets the credits per unit of consumption for the tier.
Gets or sets the name of the usage tier.
Gets or sets the overage severity status for the tier.
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.
Metric name of the credit balance, on the same entitlement, that pays for consumption in this tier. Only meaningful on a tier whose policy is AllowWithOverage: name a balance and every unit past the tier’s start is priced and charged to it on commit, refusing the commit when it cannot be paid for; leave it empty and the overage is allowed and merely reported.
Plan names this adjustment applies to; empty applies it to every plan.
How an add-on’s feature value combines with the plan-provided value.
What refers to the add-on. Only a Draft add-on nothing refers to can be deleted; any other is archived. Null where the read does not compute it, such as a catalog export.
object
Customer entitlements granted the add-on, including grants since revoked or expired.
Offers that carry a grant of the add-on.
Example
{ "status": "Draft", "features": [ { "featureType": "Boolean", "lifecycleStatus": "Draft", "visibility": "Public", "meterAggregationType": "CumulativeCounter" } ], "featureValues": [ { "usageTiers": [ { "quotaUsageLevel": "None", "quotaUsagePolicy": "None" } ], "operation": "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"}