Update a template line

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

MCP id subscription-type-items.updateAlso on this path: GET Read a template line, DELETE Delete a template line

Partially updates one template line: absent keys are untouched, and an empty body is 422.

Token scope: api:write:subscription_types
Without it: 403 insufficient-token-scope.
Permission: subscription_types::update
Without it: 403 insufficient-permission.
Feature: Needs the billing feature on your organisation.
Without it: 404 endpoint-not-found.
Rate cost: 1 unit, write bucket. A write costs the same whatever view you ask for.
Also: Accepts If-Match. Never cached: private, no-store. Unknown body keys are refused, never dropped.

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

Request

Example: Raise the template's sales price

curl -X PATCH \
  'https://<your-url>/api/v2/subscription-type-items/1' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'If-Match: *' \
  -d '{
    "default_sales_price": "34.95"
  }'

const response = await fetch('https://<your-url>/api/v2/subscription-type-items/1', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'If-Match': '*',
  },
  body: JSON.stringify({
    "default_sales_price": "34.95"
  }),
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->withHeader('If-Match', '*')
    ->patch('https://<your-url>/api/v2/subscription-type-items/1', [
        'default_sales_price' => '34.95',
    ]);

import requests
response = requests.request(
    'PATCH',
    'https://<your-url>/api/v2/subscription-type-items/1',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json', 'Content-Type': 'application/json', 'If-Match': '*'},
    json={'default_sales_price': '34.95'},
)

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": "34.95",
    "vat_rate": 1
  }
}

{
  "type": "https://developers.plnnrly.com/api/v2/problems/precondition-failed",
  "title": "Precondition failed",
  "status": 412,
  "detail": "The record changed since the version named in If-Match. Re-read it and retry.",
  "instance": "/api/v2/work-items/812",
  "request_id": "01K4B7Q9YV3PZ2N8T1E6M0XR4S",
  "current_version": 12
}

{
  "type": "https://developers.plnnrly.com/api/v2/problems/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "3 fields failed validation.",
  "instance": "/api/v2/worklogs",
  "request_id": "01K4B7Q9YV3PZ2N8T1E6M0XR4S",
  "errors": [
    {
      "pointer": "/date",
      "code": "date_format",
      "detail": "The date does not match the format Y-m-d."
    },
    {
      "pointer": "/minutes",
      "code": "min",
      "detail": "The minutes must be at least 1."
    },
    {
      "pointer": "/description",
      "code": "required",
      "detail": "The description field is required."
    }
  ]
}

5 more fields, listed under Response

Send If-Match with the ETag from your last read to detect a concurrent edit, which answers 412. subscription_type_id and sort_order are not accepted: a line cannot be moved to another type, and there is no way to reorder template lines through the API. subscribable_type and subscribable_id stay all-or-nothing: send both to re-point the line at another subscription product, or both as null to clear it. Only subscription_product is accepted, so a line pointed at a domain or a server in plnnrly can be read but never re-pointed here. Nothing is recalculated on the subscription type, and the change does not reach customer subscriptions already created from this template: that copy is taken by value at pick time.

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-Matchstring

The ETag a write is conditional on. A stale validator is 412 precondition-failed.

Request body

Unknown keys are refused with 422, naming the key.

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 null

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≥ 1

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)-99999999.99 to 99999999.99

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

2 decimal places, may be negative

At least -99999999.99. At most 99999999.99.

default_sales_pricedecimal (2 dp)-99999999.99 to 99999999.99

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

At least -99999999.99. At most 99999999.99.

vat_rateinteger0 to 100

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

subscribable_typestring 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.

Required when subscribable_id is present.

subscription_product

subscribable_idinteger or null → SubscriptionProduct.id

Required when subscribable_type is present.

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

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

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.