Update a customer subscription

PATCHhttps://<your-url>/api/v2/customer-subscriptions/{customer_subscription}

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

View as Markdown openapi.json

Partially updates a subscription: absent keys are untouched.

Token scope: api:write:customer_subscriptions
Without it: 403 insufficient-token-scope.
Permission: customer_subscriptions::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: Cancel a subscription at the end of its term

curl -X PATCH \
  'https://<your-url>/api/v2/customer-subscriptions/1' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'If-Match: *' \
  -d '{
    "status": "cancelled",
    "cancelled_at": "2026-09-30",
    "auto_renew": false
  }'

const response = await fetch('https://<your-url>/api/v2/customer-subscriptions/1', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'If-Match': '*',
  },
  body: JSON.stringify({
    "status": "cancelled",
    "cancelled_at": "2026-09-30",
    "auto_renew": false
  }),
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->withHeader('If-Match', '*')
    ->patch('https://<your-url>/api/v2/customer-subscriptions/1', [
        'status' => 'cancelled',
        'cancelled_at' => '2026-09-30',
        'auto_renew' => false,
    ]);

import requests
response = requests.request(
    'PATCH',
    'https://<your-url>/api/v2/customer-subscriptions/1',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json', 'Content-Type': 'application/json', 'If-Match': '*'},
    json={'status': 'cancelled', 'cancelled_at': '2026-09-30', 'auto_renew': False},
)

Response

The shape of the response, with sample values.

{
  "data": {
    "id": 1,
    "customer_id": 1,
    "customer": {
      "id": 1
    },
    "subscription_type_id": 1,
    "subscription_type": {
      "id": 1
    },
    "description": "Managed hosting and maintenance.",
    "status": "cancelled",
    "billing_interval": "yearly",
    "starts_at": "2026-07-01",
    "next_invoice_date": "2026-03-04",
    "cancelled_at": "2026-09-30",
    "expires_at": "2026-03-04"
  }
}

{
  "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."
    }
  ]
}

8 more fields, listed under Response

Send If-Match with the ETag from your last read to detect a concurrent edit, which answers 412. Switching billing_interval to one-time also sets auto_renew to false, whatever is sent alongside it; this holds on every save. Clearing next_invoice_date to null takes the subscription out of the renewal run without cancelling it. Lines are edited through their own sub-resource, never from here.

Path parameters

customer_subscriptionintegerRequired

The CustomerSubscription'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.

customer_idinteger → Customer.id

Customer this subscription belongs to.

subscription_type_idinteger → SubscriptionType.id

Subscription type this subscription is an instance of.

descriptionstring or null

What this subscription covers, as free text. This is the field ?q= searches, and it is also what a generated invoice line falls back to.

statusstring

Lifecycle status. Only an active subscription is picked up by the renewal run; the other three are inert.

pending: Agreed but not yet running; the renewal run ignores it.
active: Running, and the only status the renewal run invoices.
cancelled: Ended early; kept for history and never invoiced again.
expired: Ran to the end of its term and was not renewed.

New values may be added.

billing_intervalstring

How often the subscription is invoiced. one-time forces auto_renew to false, because a one-off has no next period to move on to.

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.

starts_atdate (YYYY-MM-DD)

First day the subscription runs from, as a zone-free calendar date. Newest first is the default sort.

next_invoice_datedate (YYYY-MM-DD) or null

First day of the period to be invoiced next. Omit it on create and the server fills it with starts_at, so the first period is billable; the renewal run advances it by one interval each time it invoices. Null makes the subscription invisible to that run (it is skipped, silently), so a subscription that should never auto-invoice is expressed this way.

cancelled_atdate (YYYY-MM-DD) or null

Day the subscription was cancelled, null while it has not been. It is a record of the cancellation date only: nothing derives status from it.

expires_atdate (YYYY-MM-DD) or null

Day the subscription runs out, null when it is open-ended.

auto_renewboolean

Whether the renewal run may invoice this subscription again. A one-time subscription is always false: it is forced on every save, so sending true together with billing_interval=one-time succeeds and comes back as false rather than failing.

Response 200

Returns a CustomerSubscription 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.

customer_idinteger

Customer this subscription belongs to.

customerRef or CustomerSummary

The customer this subscription belongs to. Expanding it with ?include=customer additionally requires the customers::read permission and a token scope covering the customers prefix.

subscription_type_idinteger

Subscription type this subscription is an instance of.

subscription_typeRef or SubscriptionTypeSummary

The subscription type this subscription is an instance of, which is also where its displayed name comes from. Expanding it with ?include=subscription_type additionally requires the subscription_types::read permission and a token scope covering the subscription_types prefix.

descriptionstring or nullMultiline

What this subscription covers, as free text. This is the field ?q= searches, and it is also what a generated invoice line falls back to.

statusstring

Lifecycle status. Only an active subscription is picked up by the renewal run; the other three are inert.

pendingactivecancelledexpired

New values may be added.

billing_intervalstring

How often the subscription is invoiced. one-time forces auto_renew to false, because a one-off has no next period to move on to.

yearlymonthlyone-time

New values may be added.

starts_atdate (YYYY-MM-DD)

First day the subscription runs from, as a zone-free calendar date. Newest first is the default sort.

next_invoice_datedate (YYYY-MM-DD) or null

cancelled_atdate (YYYY-MM-DD) or null

Day the subscription was cancelled, null while it has not been. It is a record of the cancellation date only: nothing derives status from it.

expires_atdate (YYYY-MM-DD) or null

Day the subscription runs out, null when it is open-ended.

auto_renewboolean

exact_subscription_idstring or null≤ 255Server-assigned

Exact Online subscription this one maps to, by Exact's own external identifier, not by a local id. Written by the sync; null when the subscription has never been synced.