Read a template line

GEThttps://<your-url>/api/v2/subscription-type-items/{subscription_type_item}

MCP id subscription-type-items.showAlso on this path: PATCH Update a template line, DELETE Delete a template line

Returns one template line in the detail view.

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.
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: One line with its type and its product expanded

curl -G \
  'https://<your-url>/api/v2/subscription-type-items/1' \
  --data-urlencode 'include=subscription_type,subscribable' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/subscription-type-items/1?include=subscription_type%2Csubscribable', {
  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-type-items/1?include=subscription_type%2Csubscribable');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/subscription-type-items/1?include=subscription_type%2Csubscribable',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json'},
)

Response

The shape of the response, with sample values.

{
  "data": {
    "id": 1,
    "subscription_type_id": 1,
    "subscription_type": {
      "id": 1
    },
    "subscribable_type": "subscription_product",
    "subscribable_id": 1,
    "subscribable": null,
    "name": "…",
    "description": "…",
    "quantity": 1,
    "default_purchase_price": "1250.00",
    "default_sales_price": "1250.00",
    "vat_rate": 1
  }
}

5 more fields, listed under Response

Template lines are soft-deleted, so a deleted line is 404 unless trashed=with or trashed=only is passed; trashed=only 404s a live line. This flat path performs no lookup of the parent subscription type: a line is readable by id to any caller holding subscription_types::read, which is what plnnrly does too. subscribable_type can read back as domain or server on a line pointed at a hosting record in plnnrly, in which case subscribable is the bare {"id": N} reference rather than an expandable object.

Path parameters

subscription_type_itemintegerRequired

The SubscriptionTypeItem's numeric id. Accepts a soft-deleted record.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

viewstring

Which field set to render.

summarydetaildefault

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 SubscriptionTypeItem in the detail view.

Headers

ETag: A strong validator of exactly this representation.
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

idinteger

Unique identifier.

subscription_type_idintegerServer-assigned

The subscription type this template line belongs to. Taken from the path on create and never writable afterwards: a line cannot be moved to another type.

subscription_typeRef or SubscriptionTypeSummary

The subscription type this template line belongs to.

subscribable_typestring or null

The kind of record subscribable points at; it says which branch of subscribable applies.

subscription_product

New values may be added.

subscribable_idinteger or null

The id of the record subscribable points at.

subscribableRef or SubscriptionProductSummary or null

The record this template line sells, normally a subscription product. Null on a line that sells nothing in particular, and a bare {"id": N} reference with subscribable_type of domain or server on a line pointed at a hosting record, which only plnnrly itself can do. Expanding it with ?include=subscribable additionally requires subscription_products read permission and a token scope covering that prefix.

Which form you get depends on subscribable_type.

subscription_product: SubscriptionProductSummary

namestring or null≤ 255

Optional label for the template line. plnnrly's form does not show it, so most existing lines carry null; it exists for programmatic naming and is what ?q= searches.

descriptionstring or nullMultiline

Invoice-line text template, copied verbatim onto the customer subscription's line and resolved only when that line is invoiced. Placeholder tokens survive the copy unresolved: {{$domain}}, {{$period}}, {{$product}}, {{$customer}}, {{$site}}, {{$server}}, plus the Dutch aliases {{$domein}}, {{$periode}} and {{$klant}}.

quantityinteger

Number of units the template line carries. Whole units: this is an integer, not the fractional quantity an invoice row uses.

default_purchase_pricedecimal (2 dp)

Purchase price per unit, excluding VAT, copied onto a new customer subscription's line.

2 decimal places, may be negative

default_sales_pricedecimal (2 dp)

Sales price per unit, excluding VAT, copied onto a new customer subscription's line. This is what eventually bills.

2 decimal places, may be negative

vat_rateinteger

VAT percentage as a whole number: 21 means 21%.

sort_orderintegerServer-assigned

Position of the line within its subscription type, and the default sort key. Assigned on create; there is no way to reorder template lines through the API.

created_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Creation timestamp.

updated_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Last-write timestamp; use for incremental sync.

deleted_attimestamp (YYYY-MM-DDThh:mm:ssZ) or null

Soft-delete timestamp, null while live.