Update a subscription type

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

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

Partially updates a type: absent keys are untouched.

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: Retire a type from the catalogue

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

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

use Illuminate\Support\Facades\Http;

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

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

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": false,
    "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": {
      "self": "https://<your-url>/api/v2/work-items/1",
      "items": "https://<your-url>/api/v2/work-items/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."
    }
  ]
}

Send If-Match with the ETag from your last read to detect a concurrent edit, which answers 412. Renaming a type also renames what its existing customer subscriptions read as: a subscription's displayed name is its type's name, resolved at read time rather than copied. Existing subscriptions keep the billing interval and renewal flag they were created with; a change here applies to subscriptions created afterwards.

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

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≤ 255

Subscription type name. It is also the name every customer subscription of this type is displayed under, so renaming a type renames what its existing subscriptions read as. Names are not unique.

descriptionstring or null

What subscriptions of this type cover, as free text.

default_billing_intervalstring

Interval a new subscription of this type is billed at by default. Omitting it on create yields yearly, the stored default, not the monthly that plnnrly's form pre-selects, which is a form convenience the API deliberately does not reproduce.

yearly: Billed once a year.
monthly: Billed every month.
one-time: Charged once, on the invoice the product is first put on, and never renewed.

New values may be added.

auto_renewboolean

Whether subscriptions created from this type renew automatically by default. The value is stored exactly as sent; nothing forces it to false.

activeboolean

Whether the type is offered in the catalogue. It is a catalogue flag only: nothing in the application filters on it, so deactivating a type does not stop existing subscriptions of that type from being renewed or invoiced.

Response 200

Returns a SubscriptionType 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