Skip to content
OclavexOclavex Docs

Lists usage plan sets belonging to the given suite, with pagination, sorting, and filtering.

GET
/api/v1/provision/admin/usage-plans/plan-sets/by-suite/{suiteId}
curl --request GET \
  --url 'https://example.com/api/v1/provision/admin/usage-plans/plan-sets/by-suite/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0?pageNumber=1&pageSize=100'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
suiteId
required
string format: uuid

Suite id.

Query Parameters

Section titled “Query Parameters”
pageNumber
integer | string format: int32
default: 1 /^-?(?:0|[1-9]\d*)$/

1-based page number to return.

pageSize
integer | string format: int32
default: 100 /^-?(?:0|[1-9]\d*)$/

Maximum number of items per page.

sortOrder
string

Optional sort expression; ascending when omitted.

filter
string

Optional filter expression applied to the results.

Responses

Section titled “Responses”

200

Section titled “200”

OK

Serializable IPaginatedList<T> implementation used to deserialize paged API responses. int PaginatedListDto<T>.TotalPages, bool PaginatedListDto<T>.HasPreviousPage, and bool PaginatedListDto<T>.HasNextPage are computed from the other properties.

object
pageNumber

The 1-based index of this page within the full result set.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
pageSize

The maximum number of items per page that was requested.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
totalCount

The total number of items across all pages.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
items

The items on this page.

Array<object>

A named collection of usage plans (e.g. “My SaaS Plans”).

object
id
string format: uuid
suiteId

The suite this plan set belongs to. A single-product plan set belongs to that product’s implicit suite-of-one. Which member each tier configures is on the plan’s line items — the set itself names no product.

string format: uuid
name
string
description
string
status

Lifecycle state of a usage plan set.

Allowed values: Draft Published Retired
revisionDate
string format: date-time
plans
Array<object>

A usage plan such as “basic”, “standard”, or “professional”.

object
id
string format: uuid
name
string
description
string
sortOrder
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
pricingMode

Whether the plan states its worth in money or in relative units. Every plan in one set shares a mode — a set is one price list — and a plan carries only its own mode’s fields: an Absolute plan is refused a RelativeWeight, a Relative plan is refused a MonthlyPrice or Currency. So nothing ever has to pick a winner between two answers to “what is this plan worth”.

Allowed values: Absolute Relative
monthlyPrice

What the plan charges per month, when PricingMode is Absolute. Three states: null = not priced yet (missing data — never treated as free), 0 = free/trial, positive = paid. Revenue reporting excludes null-priced plans and reports them separately.

null | number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
currency

ISO 4217 code (e.g. “EUR”). Required when MonthlyPrice is positive, ignored otherwise.

null | string
relativeWeight

What the plan is worth relative to its siblings, when PricingMode is Relative — an unbounded weight, not a percentage, so “Enterprise is 10x Basic” stays expressible and adding a plan never re-keys the others. Reporting turns weights into a share of the total, so the shares add up on their own. Three states mirroring MonthlyPrice: null = not weighted yet (never treated as zero), 0 = carries no weight, positive = counts.

null | number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
lineItems

One entry per suite member the tier speaks about.

Array<object>

How one tier lands on one suite member: whether the tier includes that product at all, and — when included — the feature values it stamps for it.

object
productId

The suite member this line item configures. Required on every line item except when creating a plan set for a suite of one, where the server stamps the sole member.

string format: uuid
included
boolean
featureValues
Array<object>

Defines a feature value override for a specific plan tier. Value is stored as string to support bool, enum, string, and json field values.

object
featureCode
string
metricName

The metric name this feature’s meter is keyed by — the identity every usage read and usage report must quote. It is NOT the feature code: codes are uppercase (MIRAGE.IMAGE.RENDERS), metric names are lowercase (mirage.image.renders), and the meter is resolved by an exact, case-sensitive match. Passing the code where the metric name belongs silently finds nothing.

null | string
enforcementType

How a plan enforces a feature’s value.

Allowed values: SingleValue TieredAbsolute TieredPercentage Denied NotIncluded
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

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
totalPages

The total number of pages, computed from int PaginatedListDto<T>.TotalCount and int PaginatedListDto<T>.PageSize; 0 when int PaginatedListDto<T>.PageSize is not positive.

integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
hasPreviousPage

Whether a page precedes this one (int PaginatedListDto<T>.PageNumber is greater than 1).

boolean
hasNextPage

Whether a page follows this one (int PaginatedListDto<T>.PageNumber is less than int PaginatedListDto<T>.TotalPages).

boolean