List subscription types

GEThttps://<your-url>/api/v2/subscription-types

MCP id subscription-types.indexAlso on this path: POST Create a subscription type

Returns the organisation's subscription types in catalogue order: sort_order ascending, the same order plnnrly shows.

Token scope: api:read:subscription_types
Without it: 403 insufficient-token-scope.
Permission: subscription_types::read
Without it: 403 insufficient-permission.
Feature: Needs the billing feature on your organisation.
Without it: 404 endpoint-not-found.
Rate cost: 1 unit, read bucket. view=detail makes it 3. Adds: q +2.
Also: If-None-Match answers 304 when nothing changed. Never cached: private, no-store. Unknown query parameters are refused, never ignored.

Both are checked, scope first. A token never does more than its user. How access is checked

Request

Example: Active types in catalogue order

curl -G \
  'https://<your-url>/api/v2/subscription-types' \
  --data-urlencode 'filter[active]=true' \
  --data-urlencode 'sort=sort_order' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/subscription-types?filter[active]=true&sort=sort_order', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
  },
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->get('https://<your-url>/api/v2/subscription-types?filter[active]=true&sort=sort_order');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/subscription-types?filter[active]=true&sort=sort_order',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json'},
)

Response

The shape of the response, with sample values.

{
  "data": [
    {
      "id": 1,
      "name": "Hosting retainer",
      "description": "Managed hosting and monitoring, billed monthly.",
      "default_billing_interval": "monthly",
      "auto_renew": true,
      "active": true,
      "sort_order": 1,
      "created_at": "2026-03-04T09:15:00Z",
      "updated_at": "2026-03-04T09:15:00Z",
      "deleted_at": "2026-03-04T09:15:00Z",
      "items_count": 1,
      "links": {
        "…": "2 fields of SubscriptionTypeLinks"
      }
    }
  ],
  "meta": {
    "page": {
      "per_page": 1,
      "next_cursor": "…",
      "prev_cursor": "…",
      "total": 1,
      "current_page": 1,
      "last_page": 1
    }
  },
  "links": {
    "self": "https://<your-url>/api/v2/work-items/1",
    "next": "https://<your-url>/api/v2/work-items/1",
    "prev": "https://<your-url>/api/v2/work-items/1"
  }
}

Defaults to the summary view; view=detail carries the same fields on this resource (no field of it is detail-only) and costs three read units instead of one. Search with q= over the type name, and pass trashed=with|only to see deleted types.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

18 parameters in 6 groups

Views

viewstring

Which field set to render.

summarydefaultdetail

Pagination

per_pageinteger1 to 100

Rows per page. At most 25 when include names a to-many relation; a larger value is 400 invalid-query-parameter.

Default: 25

cursorstring

Opaque keyset cursor from a previous page's links.next. Never construct one by hand.

pageinteger1 to 1000

Opt in to page-number paging: 1-based, at most 1000. Omit it, the default, to page by opaque cursor, which is what links.next hands you. Cannot be combined with cursor. Published only on collections that count their rows on every request. This collection's default sort is a display position that changes whenever someone drags the list into a new order in plnnrly, so a page number can skip or repeat a row if the list is reordered between two page requests. These collections rarely exceed one page; for a stable walk, send sort=id and follow links.next without page.

Filters

=: equals
[in]: any of a comma-separated list
[gte][lt]: at least, less than
[ne]: not equal

filter[active]boolean

Whether the type is offered in the catalogue.

filter[auto_renew]boolean

Whether subscriptions of this type renew automatically by default.

filter[created_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lt]

Creation timestamp. Pair with sort=id for a stable full export.

filter[default_billing_interval]string=[ne][in]

Interval new subscriptions of this type are billed at by default.

A comma-separated list of at most 100 values.

yearlymonthlyone-time

New values may be added.

filter[updated_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lt]

Last-write timestamp. Use for incremental sync.

Search

qstring

Free-text search over name. At most one substring match per request: q together with a contains filter is 400 invalid-query-parameter.

Sorting

sortstring

Up to three keys, comma-separated, each optionally prefixed with - for descending.

Default: sort_order

Key	Sorts by
`sort_order`	Position in the catalogue, as ordered in plnnrly. This is the default sort.
`name`	Subscription type name, A→Z.
`id`	Id, ascending. An id never changes, so use this for a stable full export.
`updated_at`	Last-write timestamp; pair with the id tiebreaker for sync.

Prefix a key with - for descending.

Other

trashedstring

Whether soft-deleted rows are included.

withoutdefaultwithonly

Request headers

X-Request-Idstringpattern

A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.

If-None-Matchstring

The ETag a read is conditional on. A match is answered 304 with no body.

Response 200

Returns a page of SubscriptionTypeList rows.

dataarray of SubscriptionTypeList

The rows, each a SubscriptionTypeList.

meta.pagePage

per_page, next_cursor, prev_cursor, total, current_page, last_page.

linksPageLinks

self, next, prev.

Each row is a SubscriptionTypeList: 12 fields.

Headers

ETag: A weak validator (W/"…") of the rendered page.
RateLimit: The IETF httpapi-ratelimit-headers form of your remaining allowance on the tightest bucket this request touched.
RateLimit-Policy: The ceiling and window of that bucket, as <limit>;w=<seconds>.
X-Request-Id: The server-generated ULID correlating this response with our logs.

Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning