Archives an add-on so it can no longer be granted to new entitlements.

POST

/api/v1/provision/admin/usage-plans/add-ons/{addOnId}/archive

curl --request POST \
  --url https://example.com/api/v1/provision/admin/usage-plans/add-ons/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/archive

Parameters

Path Parameters

addOnId

required

string format: uuid

Add-on id.

Responses

200

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

id

string format: uuid

suiteId

string format: uuid

code

string

name

string

description

string

status

Lifecycle state of an add-on.

Allowed values: Draft Published Archived

features

Array<object>

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

id

string format: uuid

productId

string format: uuid

featureCode

string

name

string

units

null | string

metricName

Metric name a Metered feature reports usage under.

null | string

featureType

Data type of a feature’s value; determines how Value strings are interpreted and enforced.

Allowed values: Boolean Numeric Text Enumeration Metered JsonField

lifecycleStatus

Lifecycle state of a feature catalog entry.

Allowed values: Draft Preview Published Disabled Archived

visibility

Who can see a feature.

Allowed values: Public Internal

meterAggregationType

One of:

null

null

unknown

How reported meter values are aggregated; only meaningful for Metered features.

Allowed values: CumulativeCounter TotalCounter Gauge UpDownCounter

valueScore

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.

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

enumOptions

Array<object>

One allowed value of an Enumeration-typed feature.

object

value

string

description

null | string

tags

Tag names applied to this entry, from the tenant’s TagScopeDto.FeatureCatalog vocabulary.

Array<string>

isDeleted

boolean

creationTimeStamp

string format: date-time

lastUpdateTimeStamp

null | string format: date-time

revisionNumber

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

featureValues

Array<object>

One feature adjustment an add-on applies, and how it combines with the plan value.

object

featureCode

string

value

Operand for the operation, as a string interpreted per the feature’s data type; unused for Tiered.

null | string

usageTiers

Usage tiers applied when AddOnFeatureValueOperationDto AddOnFeatureValueDto.Operation is Tiered.

Array<object>

Represents a tier of usage with associated credits and severity status.

object

startUsage

Gets or sets the start usage for the tier.

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

startPercentage

Tier start as a percentage of the feature value (percentage-based enforcement).

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

endUsage

Gets or sets the end usage for the tier. Nullable.

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

endPercentage

Tier end as a percentage of the feature value (percentage-based enforcement).

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

baseCredits

Gets or sets the flat fee credits for the tier.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

creditsPerUnitOfConsumption

Gets or sets the credits per unit of consumption for the tier.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

name

Gets or sets the name of the usage tier.

string

quotaUsageLevel

Gets or sets the overage severity status for the tier.

Allowed values: None Normal Warning Critical OverUsage

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.

Allowed values: None NotifyOnly AllowWithOverage AllowWithGrace RateLimit Deny SuspendUsage

fundingBalanceMetric

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.

string

planTargets

Plan names this adjustment applies to; empty applies it to every plan.

Array<string>

operation

How an add-on’s feature value combines with the plan-provided value.

Allowed values: Replace Add Multiply Tiered

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

id

string format: uuid

suiteId

string format: uuid

code

string

name

string

description

string

status

Lifecycle state of an add-on.

Allowed values: Draft Published Archived

features

Array<object>

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

id

string format: uuid

productId

string format: uuid

featureCode

string

name

string

units

null | string

metricName

Metric name a Metered feature reports usage under.

null | string

featureType

Data type of a feature’s value; determines how Value strings are interpreted and enforced.

Allowed values: Boolean Numeric Text Enumeration Metered JsonField

lifecycleStatus

Lifecycle state of a feature catalog entry.

Allowed values: Draft Preview Published Disabled Archived

visibility

Who can see a feature.

Allowed values: Public Internal

meterAggregationType

One of:

null

null

unknown

How reported meter values are aggregated; only meaningful for Metered features.

Allowed values: CumulativeCounter TotalCounter Gauge UpDownCounter

valueScore

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.

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

enumOptions

Array<object>

One allowed value of an Enumeration-typed feature.

object

value

string

description

null | string

tags

Tag names applied to this entry, from the tenant’s TagScopeDto.FeatureCatalog vocabulary.

Array<string>

isDeleted

boolean

creationTimeStamp

string format: date-time

lastUpdateTimeStamp

null | string format: date-time

revisionNumber

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

featureValues

Array<object>

One feature adjustment an add-on applies, and how it combines with the plan value.

object

featureCode

string

value

Operand for the operation, as a string interpreted per the feature’s data type; unused for Tiered.

null | string

usageTiers

Usage tiers applied when AddOnFeatureValueOperationDto AddOnFeatureValueDto.Operation is Tiered.

Array<object>

Represents a tier of usage with associated credits and severity status.

object

startUsage

Gets or sets the start usage for the tier.

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

startPercentage

Tier start as a percentage of the feature value (percentage-based enforcement).

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

endUsage

Gets or sets the end usage for the tier. Nullable.

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

endPercentage

Tier end as a percentage of the feature value (percentage-based enforcement).

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

baseCredits

Gets or sets the flat fee credits for the tier.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

creditsPerUnitOfConsumption

Gets or sets the credits per unit of consumption for the tier.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

name

Gets or sets the name of the usage tier.

string

quotaUsageLevel

Gets or sets the overage severity status for the tier.

Allowed values: None Normal Warning Critical OverUsage

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.

Allowed values: None NotifyOnly AllowWithOverage AllowWithGrace RateLimit Deny SuspendUsage

fundingBalanceMetric

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.

string

planTargets

Plan names this adjustment applies to; empty applies it to every plan.

Array<string>

operation

How an add-on’s feature value combines with the plan-provided value.

Allowed values: Replace Add Multiply Tiered

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

id

string format: uuid

suiteId

string format: uuid

code

string

name

string

description

string

status

Lifecycle state of an add-on.

Allowed values: Draft Published Archived

features

Array<object>

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

id

string format: uuid

productId

string format: uuid

featureCode

string

name

string

units

null | string

metricName

Metric name a Metered feature reports usage under.

null | string

featureType

Data type of a feature’s value; determines how Value strings are interpreted and enforced.

Allowed values: Boolean Numeric Text Enumeration Metered JsonField

lifecycleStatus

Lifecycle state of a feature catalog entry.

Allowed values: Draft Preview Published Disabled Archived

visibility

Who can see a feature.

Allowed values: Public Internal

meterAggregationType

One of:

null

null

unknown

How reported meter values are aggregated; only meaningful for Metered features.

Allowed values: CumulativeCounter TotalCounter Gauge UpDownCounter

valueScore

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.

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

enumOptions

Array<object>

One allowed value of an Enumeration-typed feature.

object

value

string

description

null | string

tags

Tag names applied to this entry, from the tenant’s TagScopeDto.FeatureCatalog vocabulary.

Array<string>

isDeleted

boolean

creationTimeStamp

string format: date-time

lastUpdateTimeStamp

null | string format: date-time

revisionNumber

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

featureValues

Array<object>

One feature adjustment an add-on applies, and how it combines with the plan value.

object

featureCode

string

value

Operand for the operation, as a string interpreted per the feature’s data type; unused for Tiered.

null | string

usageTiers

Usage tiers applied when AddOnFeatureValueOperationDto AddOnFeatureValueDto.Operation is Tiered.

Array<object>

Represents a tier of usage with associated credits and severity status.

object

startUsage

Gets or sets the start usage for the tier.

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

startPercentage

Tier start as a percentage of the feature value (percentage-based enforcement).

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

endUsage

Gets or sets the end usage for the tier. Nullable.

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

endPercentage

Tier end as a percentage of the feature value (percentage-based enforcement).

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

baseCredits

Gets or sets the flat fee credits for the tier.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

creditsPerUnitOfConsumption

Gets or sets the credits per unit of consumption for the tier.

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

name

Gets or sets the name of the usage tier.

string

quotaUsageLevel

Gets or sets the overage severity status for the tier.

Allowed values: None Normal Warning Critical OverUsage

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.

Allowed values: None NotifyOnly AllowWithOverage AllowWithGrace RateLimit Deny SuspendUsage

fundingBalanceMetric

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.

string

planTargets

Plan names this adjustment applies to; empty applies it to every plan.

Array<string>

operation

How an add-on’s feature value combines with the plan-provided value.

Allowed values: Replace Add Multiply Tiered

Example

{
  "status": "Draft",
  "features": [
    {
      "featureType": "Boolean",
      "lifecycleStatus": "Draft",
      "visibility": "Public",
      "meterAggregationType": "CumulativeCounter"
    }
  ],
  "featureValues": [
    {
      "usageTiers": [
        {
          "quotaUsageLevel": "None",
          "quotaUsagePolicy": "None"
        }
      ],
      "operation": "Replace"
    }
  ]
}

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