Add a template line to a subscription type

POSThttps://<your-url>/api/v2/subscription-types/{subscription_type}/items

MCP id subscription-types.items.storeAlso on this path: GET List a subscription type's template lines

Creates one template line on the subscription type named in the path and returns it in the detail view, with a Location header pointing at the flat item path.

Token scope: api:write:subscription_types
Without it: 403 insufficient-token-scope.
Permission: subscription_types::create
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 Idempotency-Key. 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: A template line selling one subscription product

curl -X POST \
  'https://<your-url>/api/v2/subscription-types/1/items' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: <key>' \
  -d '{
    "name": "Managed hosting",
    "description": "Hosting for {{$domain}} over {{$period}}.",
    "quantity": 1,
    "default_purchase_price": "12.50",
    "default_sales_price": "29.95",
    "subscribable_type": "subscription_product",
    "subscribable_id": 1
  }'

const response = await fetch('https://<your-url>/api/v2/subscription-types/1/items', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Idempotency-Key': '<key>',
  },
  body: JSON.stringify({
    "name": "Managed hosting",
    "description": "Hosting for {{$domain}} over {{$period}}.",
    "quantity": 1,
    "default_purchase_price": "12.50",
    "default_sales_price": "29.95",
    "subscribable_type": "subscription_product",
    "subscribable_id": 1
  }),
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->withHeader('Idempotency-Key', '<key>')
    ->post('https://<your-url>/api/v2/subscription-types/1/items', [
        'name' => 'Managed hosting',
        'description' => 'Hosting for {{$domain}} over {{$period}}.',
        'quantity' => 1,
        'default_purchase_price' => '12.50',
        'default_sales_price' => '29.95',
        'subscribable_type' => 'subscription_product',
        'subscribable_id' => 1,
    ]);

import requests
response = requests.request(
    'POST',
    'https://<your-url>/api/v2/subscription-types/1/items',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json', 'Content-Type': 'application/json', 'Idempotency-Key': '<key>'},
    json={'name': 'Managed hosting', 'description': 'Hosting for {{$domain}} over {{$period}}.', 'quantity': 1, 'default_purchase_price': '12.50', 'default_sales_price': '29.95', 'subscribable_type': 'subscription_product', 'subscribable_id': 1},
)

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": "Managed hosting",
    "description": "Hosting for {{$domain}} over {{$period}}.",
    "quantity": 1,
    "default_purchase_price": "12.50",
    "default_sales_price": "29.95",
    "vat_rate": 1
  }
}

{
  "type": "https://developers.plnnrly.com/api/v2/problems/idempotency-key-in-flight",
  "title": "Idempotency key in flight",
  "status": 409,
  "detail": "The original request for this Idempotency-Key is still being processed. Retry shortly.",
  "instance": "/api/v2/worklogs",
  "request_id": "01K4B7Q9YV3PZ2N8T1E6M0XR4S"
}

{
  "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

The type comes from the path, so subscription_type_id is not accepted in the body and a line can never be moved between types. Every field is optional: a POST with an empty body creates a blank line, exactly as plnnrly's form does when a line is added. subscribable_type and subscribable_id are all-or-nothing and the only accepted type is subscription_product: a line can be pointed at a hosting domain or server in plnnrly, and a GET will report that, but not through this API. Nothing on the subscription type itself is recalculated: a type is a blueprint and has no totals. A deleted type answers 404.

Path parameters

subscription_typeintegerRequired

The SubscriptionType'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

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.

Idempotency-Keystring≤ 255

A caller-chosen key that makes this POST safe to retry. Replaying it returns the original response with Idempotency-Replayed: true.

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 201

Returns a SubscriptionTypeItem in the detail view.

Headers

ETag: A strong validator of exactly this representation.
Idempotency-Replayed: true when this response was replayed from a stored Idempotency-Key rather than produced by a new write.
Location: The absolute URL of the created or queued resource.
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.