--- title: "List plans" method: GET path: "/openmeter/plans" tags: ["OpenMeter Product Catalog"] --- # List plans `GET /openmeter/plans` List all plans. ## Query parameters - `page` object - `size` integer — The number of items to include per page. - `number` integer — The page number. - `sort` string — The `asc` suffix is optional as the default sort order is ascending. The `desc` suffix is used to specify a descending order. Multiple sort attributes may be provided via a comma separated list. JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc'). - `filter` ListPlansParamsFilter — Filter options for listing plans. - `key` union — Filters on the given string field value by either exact or fuzzy match. All properties are optional; provide exactly one to specify the comparison. - string - object - `eq` string — Value strictly equals the given string value. - `neq` string — Value does not equal the given string value. - `contains` string — Value contains the given string value (fuzzy match). - `ocontains` string — Returns entities that fuzzy-match any of the comma-delimited phrases in the filter string. - `oeq` string — Returns entities that exact match any of the comma-delimited phrases in the filter string. - `gt` string — Value is greater than the given string value (lexicographic compare). - `gte` string — Value is greater than or equal to the given string value (lexicographic compare). - `lt` string — Value is less than the given string value (lexicographic compare). - `lte` string — Value is less than or equal to the given string value (lexicographic compare). - `exists` boolean — When true, the field must be present (non-null); when false, the field must be absent (null). - `name` union — Filters on the given string field value by either exact or fuzzy match. All properties are optional; provide exactly one to specify the comparison. - string - object - `eq` string — Value strictly equals the given string value. - `neq` string — Value does not equal the given string value. - `contains` string — Value contains the given string value (fuzzy match). - `ocontains` string — Returns entities that fuzzy-match any of the comma-delimited phrases in the filter string. - `oeq` string — Returns entities that exact match any of the comma-delimited phrases in the filter string. - `gt` string — Value is greater than the given string value (lexicographic compare). - `gte` string — Value is greater than or equal to the given string value (lexicographic compare). - `lt` string — Value is less than the given string value (lexicographic compare). - `lte` string — Value is less than or equal to the given string value (lexicographic compare). - `exists` boolean — When true, the field must be present (non-null); when false, the field must be absent (null). - `status` union — Filters on the given string field value by exact match. All properties are optional; provide exactly one to specify the comparison. - string - object - `eq` string — Value strictly equals the given string value. - `oeq` string — Returns entities that exact match any of the comma-delimited phrases in the filter string. - `neq` string — Value does not equal the given string value. - `currency` union — Filters on the given string field value by exact match. All properties are optional; provide exactly one to specify the comparison. - string - object - `eq` string — Value strictly equals the given string value. - `oeq` string — Returns entities that exact match any of the comma-delimited phrases in the filter string. - `neq` string — Value does not equal the given string value. ## Response `200` Page paginated response. - PlanPagePaginatedResponse — Page paginated response. - `data` BillingPlan[], required - `id` string, required — ULID (Universally Unique Lexicographically Sortable Identifier). - `name` string, required — Display name of the resource. Between 1 and 256 characters. - `description` string — Optional description of the resource. Maximum 1024 characters. - `labels` Labels — Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_". - `created_at` string, date-time, required — [RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in UTC. - `updated_at` string, date-time, required — [RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in UTC. - `deleted_at` string, date-time — [RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in UTC. - `key` string, required — A key is a unique string that is used to identify a resource. - `version` integer, required — Plans are versioned to allow you to make changes without affecting running subscriptions. - `currency` union, required — Fiat or custom currency code. - string — Three-letter [ISO4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. Custom three-letter currency codes are also supported for convenience. - string — Custom currency code. It should be a unique code but not conflicting with any existing fiat currency codes. - `billing_cadence` string, ISO8601, required — [ISO 8601 Duration](https://docs.digi.com/resources/documentation/digidocs/90001488-13/reference/r_iso_8601_duration_format.htm) string. - `pro_rating_enabled` boolean — Whether pro-rating is enabled for this plan. - `effective_from` string, date-time — [RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in UTC. - `effective_to` string, date-time — [RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in UTC. - `status` 'draft' | 'active' | 'archived' | 'scheduled', required — The status of a plan. - `draft`: The plan has not yet been published and can be edited. - `active`: The plan is published and can be used in subscriptions. - `archived`: The plan is no longer available for use. - `scheduled`: The plan is scheduled to be published at a future date. - `phases` BillingPlanPhase[], required — The plan phases define the pricing ramp for a subscription. A phase switch occurs only at the end of a billing period. At least one phase is required. - `name` string, required — Display name of the resource. Between 1 and 256 characters. - `description` string — Optional description of the resource. Maximum 1024 characters. - `labels` Labels — Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_". - `key` string, required — A key is a unique string that is used to identify a resource. - `duration` string, ISO8601 — [ISO 8601 Duration](https://docs.digi.com/resources/documentation/digidocs/90001488-13/reference/r_iso_8601_duration_format.htm) string. - `rate_cards` BillingRateCard[], required — The rate cards of the plan. - `name` string, required — Display name of the resource. Between 1 and 256 characters. - `description` string — Optional description of the resource. Maximum 1024 characters. - `labels` Labels — Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_". - `key` string, required — A key is a unique string that is used to identify a resource. - `feature` FeatureReference — Feature reference. - `id` string, required — ULID (Universally Unique Lexicographically Sortable Identifier). - `currency` union — Fiat or custom currency code. - string — Three-letter [ISO4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. Custom three-letter currency codes are also supported for convenience. - string — Custom currency code. It should be a unique code but not conflicting with any existing fiat currency codes. - `billing_cadence` string, ISO8601 — [ISO 8601 Duration](https://docs.digi.com/resources/documentation/digidocs/90001488-13/reference/r_iso_8601_duration_format.htm) string. - `price` union, required — Price. - object — Free price. - `type` 'free', required — The type of the price. - object — Flat price. - `type` 'flat', required — The type of the price. - `amount` string, required — Numeric represents an arbitrary precision number. - object — Unit price. Charges a fixed rate per billing unit. When UnitConfig is present on the rate card, billing units are the converted quantities (e.g. GB instead of bytes). - `type` 'unit', required — The type of the price. - `amount` string, required — Numeric represents an arbitrary precision number. - object — Graduated tiered price. Each tier's rate applies only to the usage within that tier. Pricing can change as cumulative usage crosses tier boundaries. When UnitConfig is present on the rate card, tier boundaries (up_to_amount) are expressed in converted billing units. - `type` 'graduated', required — The type of the price. - `tiers` BillingPriceTier[], required — The tiers of the graduated price. At least one tier is required. - … - object — Volume tiered price. The maximum quantity within a period determines the per-unit price for all units in that period. When UnitConfig is present on the rate card, tier boundaries (up_to_amount) are expressed in converted billing units. - `type` 'volume', required — The type of the price. - `tiers` BillingPriceTier[], required — The tiers of the volume price. At least one tier is required. - … - `unit_config` BillingUnitConfig — Unit conversion configuration. Transforms raw metered quantities into billing-ready units before pricing and entitlement evaluation. Applied at the rate card level so the same feature can be billed in different units across plans. Examples: - Meter bytes, bill GB: operation=divide, conversionFactor=1e9, rounding=ceiling, displayUnit="GB" - Meter seconds, bill hours: operation=divide, conversionFactor=3600, rounding=ceiling, displayUnit="hours" - Cost + 20% margin: operation=multiply, conversionFactor=1.2 - Bill per million tokens: operation=divide, conversionFactor=1e6, rounding=ceiling, displayUnit="M" v1 equivalents: - DynamicPrice(multiplier): operation=multiply, conversionFactor=multiplier + UnitPrice(amount=1) - PackagePrice(amount, quantityPerPkg): operation=divide, conversionFactor=quantityPerPkg, rounding=ceiling + UnitPrice(amount) - `operation` 'divide' | 'multiply', required — The arithmetic operation used to convert raw metered units into billing units. - `divide`: Divide the metered quantity by the conversion factor (e.g., bytes ÷ 1e9 = GB). - `multiply`: Multiply the metered quantity by the conversion factor (e.g., cost × 1.2 = cost + 20% margin). - `conversion_factor` string, required — Numeric represents an arbitrary precision number. - `rounding` 'ceiling' | 'floor' | 'half_up' | 'none' — The rounding mode applied to the converted quantity for invoicing. Rounding is applied only to the invoiced quantity. Entitlement balance checks use the precise decimal value after conversion. - `ceiling`: Round up to the next integer (typical for package-style billing). - `floor`: Round down to the previous integer. - `half_up`: Round to the nearest integer, with 0.5 rounding up. - `none`: No rounding; the converted value is used as-is. - `precision` integer — The number of decimal places to retain after rounding. Only meaningful when rounding is not "none". Defaults to 0 (round to whole numbers). - `display_unit` string — A human-readable label for the converted unit shown on invoices and in the customer portal (e.g., "GB", "hours", "M tokens"). Optional. When omitted, no unit label is rendered. - `payment_term` 'in_advance' | 'in_arrears' — The payment term of a flat price. - `commitments` BillingSpendCommitments — Spend commitments for a rate card. The customer is committed to spend at least the minimum amount and at most the maximum amount. - `minimum_amount` string — Numeric represents an arbitrary precision number. - `maximum_amount` string — Numeric represents an arbitrary precision number. - `discounts` BillingRateCardDiscounts — Discount configuration for a rate card. - `percentage` number — Percentage discount applied to the price (0–100). - `usage` string — Numeric represents an arbitrary precision number. - `tax_config` BillingRateCardTaxConfig — The tax config of the rate card. - `behavior` 'inclusive' | 'exclusive' — Tax behavior. This enum is used to specify whether tax is included in the price or excluded from the price. - `code` TaxCodeReference, required — TaxCode reference. - `id` string, required — ULID (Universally Unique Lexicographically Sortable Identifier). - `entitlement` union — Entitlement template configured on a rate card. The feature is taken from the rate card itself, so it is omitted here. - object — The entitlement template of a metered entitlement. - `type` 'metered', required — The type of the entitlement template. - `is_soft_limit` boolean — If soft limit is true, the subject can use the feature even if the entitlement is exhausted; access remains granted. - `limit` number, double — The amount of usage granted each usage period, in the feature's unit. Usage is counted against this allowance and the balance resets every usage period. When `is_soft_limit` is true the subject keeps access after the limit is reached; otherwise access is denied once the allowance is exhausted. - `usage_period` string, ISO8601 — [ISO 8601 Duration](https://docs.digi.com/resources/documentation/digidocs/90001488-13/reference/r_iso_8601_duration_format.htm) string. - object — The entitlement template of a static entitlement. - `type` 'static', required — The type of the entitlement template. - `config` unknown, required - object — The entitlement template of a boolean entitlement. - `type` 'boolean', required — The type of the entitlement template. - `settlement_mode` 'credit_then_invoice' | 'credit_only' — Settlement mode for billing. Values: - `credit_then_invoice`: Credits are applied first, then any remainder is invoiced. - `credit_only`: Usage is settled exclusively against credits. - `validation_errors` ProductCatalogValidationError[] — List of validation errors in `draft` state that prevent the plan from being published. - `code` string, required — Machine-readable error code. - `message` string, required — Human-readable description of the error. - `attributes` object — Additional structured context. - `field` string, required — The path to the field. - `meta` PaginatedMeta, required — returns the pagination information - `page` PageMeta, required — Contains pagination query parameters and the total number of objects returned. - `number` number, required - `size` number, required - `total` number, required ## Other responses - `400` — Bad Request - `401` — Unauthorized - `403` — Forbidden --- [API](https://skmtc.net/openmeterio/apis/openmeter-and-konnect-metering-billing-api.md) · [All operations](https://skmtc.net/openmeterio/apis/openmeter-and-konnect-metering-billing-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openmeterio/openmeter-and-konnect-metering-billing-api/versions/9bca44e2d61d/schema)