Retrieves a bundle by id.

GET

/api/v1/provision/admin/usage-plans/bundles/{bundleId}

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

Parameters

Path Parameters

bundleId

required

string format: uuid

Bundle id.

Responses

200

OK

object

id

string format: uuid

entitlementTemplateId

string format: uuid

usagePlanSetId

string format: uuid

code

string

name

string

description

string

status

integer

features

Array<object>

object

id

string format: uuid

productId

string format: uuid

featureCode

string

name

string

units

null | string

metricName

null | string

featureType

integer

lifecycleStatus

integer

visibility

integer

meterAggregationType

One of:

null

null

integer

integer

enableUserRating

boolean

ratingPriority

null | integer | string format: int32

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

ratingQuestion

null | string

enumOptions

Array<object>

object

value

string

description

null | 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>

object

featureCode

string

value

null | string

usageTiers

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

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

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.

integer

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.

integer

planTargets

Array<string>

operation

integer

object

id

string format: uuid

entitlementTemplateId

string format: uuid

usagePlanSetId

string format: uuid

code

string

name

string

description

string

status

integer

features

Array<object>

object

id

string format: uuid

productId

string format: uuid

featureCode

string

name

string

units

null | string

metricName

null | string

featureType

integer

lifecycleStatus

integer

visibility

integer

meterAggregationType

One of:

null

null

integer

integer

enableUserRating

boolean

ratingPriority

null | integer | string format: int32

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

ratingQuestion

null | string

enumOptions

Array<object>

object

value

string

description

null | 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>

object

featureCode

string

value

null | string

usageTiers

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

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

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.

integer

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.

integer

planTargets

Array<string>

operation

integer

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "entitlementTemplateId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "usagePlanSetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "code": "example",
  "name": "example",
  "description": "example",
  "status": 1,
  "features": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "featureCode": "example",
      "name": "example",
      "units": "example",
      "metricName": "example",
      "featureType": 1,
      "lifecycleStatus": 1,
      "visibility": 1,
      "meterAggregationType": "example",
      "enableUserRating": true,
      "ratingPriority": 1,
      "ratingQuestion": "example",
      "enumOptions": [
        {
          "value": "example",
          "description": "example"
        }
      ],
      "isDeleted": true,
      "creationTimeStamp": "2026-04-15T12:00:00Z",
      "lastUpdateTimeStamp": "2026-04-15T12:00:00Z",
      "revisionNumber": 1
    }
  ],
  "featureValues": [
    {
      "featureCode": "example",
      "value": "example",
      "usageTiers": [
        {
          "startUsage": 1,
          "startPercentage": 1,
          "endUsage": 1,
          "endPercentage": 1,
          "baseCredits": 1,
          "creditsPerUnitOfConsumption": 1,
          "name": "example",
          "quotaUsageLevel": 1,
          "quotaUsagePolicy": 1
        }
      ],
      "planTargets": [
        "example"
      ],
      "operation": 1
    }
  ]
}

object

id

string format: uuid

entitlementTemplateId

string format: uuid

usagePlanSetId

string format: uuid

code

string

name

string

description

string

status

integer

features

Array<object>

object

id

string format: uuid

productId

string format: uuid

featureCode

string

name

string

units

null | string

metricName

null | string

featureType

integer

lifecycleStatus

integer

visibility

integer

meterAggregationType

One of:

null

null

integer

integer

enableUserRating

boolean

ratingPriority

null | integer | string format: int32

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

ratingQuestion

null | string

enumOptions

Array<object>

object

value

string

description

null | 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>

object

featureCode

string

value

null | string

usageTiers

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

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

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.

integer

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.

integer

planTargets

Array<string>

operation

integer

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "entitlementTemplateId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "usagePlanSetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "code": "example",
  "name": "example",
  "description": "example",
  "status": 1,
  "features": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "featureCode": "example",
      "name": "example",
      "units": "example",
      "metricName": "example",
      "featureType": 1,
      "lifecycleStatus": 1,
      "visibility": 1,
      "meterAggregationType": "example",
      "enableUserRating": true,
      "ratingPriority": 1,
      "ratingQuestion": "example",
      "enumOptions": [
        {
          "value": "example",
          "description": "example"
        }
      ],
      "isDeleted": true,
      "creationTimeStamp": "2026-04-15T12:00:00Z",
      "lastUpdateTimeStamp": "2026-04-15T12:00:00Z",
      "revisionNumber": 1
    }
  ],
  "featureValues": [
    {
      "featureCode": "example",
      "value": "example",
      "usageTiers": [
        {
          "startUsage": 1,
          "startPercentage": 1,
          "endUsage": 1,
          "endPercentage": 1,
          "baseCredits": 1,
          "creditsPerUnitOfConsumption": 1,
          "name": "example",
          "quotaUsageLevel": 1,
          "quotaUsagePolicy": 1
        }
      ],
      "planTargets": [
        "example"
      ],
      "operation": 1
    }
  ]
}

401

Unauthorized

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

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