---
title: "List subscriptions"
method: GET
path: "/v3/openmeter/subscriptions"
tags: ["OpenMeter Subscriptions"]
---

# List subscriptions

`GET /v3/openmeter/subscriptions`

## 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` ListSubscriptionsParamsFilter — Filter options for listing subscriptions.
  - `id` union — Filters on the given ULID field value by exact match. All properties are optional; provide exactly one to specify the comparison.
    - string — ULID (Universally Unique Lexicographically Sortable Identifier).
    - object
      - `eq` string — Value strictly equals the given ULID value.
      - `oeq` string, ArrayEncoding.commaDelimited — Returns entities that exact match any of the comma-delimited ULIDs in the filter string.
      - `neq` string — Value does not equal the given ULID value.
  - `customer_id` union — Filters on the given ULID field value by exact match. All properties are optional; provide exactly one to specify the comparison.
    - string — ULID (Universally Unique Lexicographically Sortable Identifier).
    - object
      - `eq` string — Value strictly equals the given ULID value.
      - `oeq` string, ArrayEncoding.commaDelimited — Returns entities that exact match any of the comma-delimited ULIDs in the filter string.
      - `neq` string — Value does not equal the given ULID value.
  - `status` StringFieldFilterExact — Filter using **one** of the following operators: `eq`, `oeq`, `neq`
    - `eq` string — The field exactly matches the provided value.
    - `oeq` string — The field matches any of the provided values.
    - `neq` string — The field does not match the provided value.
  - `plan_id` union — Filters on the given ULID field value by exact match. All properties are optional; provide exactly one to specify the comparison.
    - string — ULID (Universally Unique Lexicographically Sortable Identifier).
    - object
      - `eq` string — Value strictly equals the given ULID value.
      - `oeq` string, ArrayEncoding.commaDelimited — Returns entities that exact match any of the comma-delimited ULIDs in the filter string.
      - `neq` string — Value does not equal the given ULID value.
  - `plan_key` StringFieldFilterExact — Filter using **one** of the following operators: `eq`, `oeq`, `neq`
    - `eq` string — The field exactly matches the provided value.
    - `oeq` string — The field matches any of the provided values.
    - `neq` string — The field does not match the provided value.

## Response `200`

Page paginated response.

- SubscriptionPagePaginatedResponse — Page paginated response.
  - `data` BillingSubscription[], required
    - `id` string, required — ULID (Universally Unique Lexicographically Sortable Identifier).
    - `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 — An ISO-8601 timestamp representation of entity creation date.
    - `updated_at` string, date-time, required — An ISO-8601 timestamp representation of entity last update date.
    - `deleted_at` string, date-time — An ISO-8601 timestamp representation of entity deletion date.
    - `customer_id` string, required — The customer ID of the subscription.
    - `plan_id` string — The plan ID of the subscription. Set if subscription is created from a plan.
    - `billing_anchor` string, date-time, required — A billing anchor is the fixed point in time that determines the subscription's recurring billing cycle. It affects when charges occur and how prorations are calculated. Common anchors: - Calendar month (1st of each month): `2025-01-01T00:00:00Z` - Subscription anniversary (day customer signed up) - Custom date (customer-specified day)
    - `status` 'active' | 'inactive' | 'canceled' | 'scheduled', required — The status of the subscription.
    - `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.
  - `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
- `404` — Not Found

---

[API](https://skmtc.net/kong/apis/konnect-api-go-sdk.md) · [All operations](https://skmtc.net/kong/apis/konnect-api-go-sdk/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kong/konnect-api-go-sdk/revisions/4fef3868064f/schema)
