Delete a customer subscription

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

MCP id customer-subscriptions.destroyAlso on this path: GET Read a customer subscription, PATCH Update a customer subscription

View as Markdown openapi.json

Soft-deletes a subscription: it is only marked deleted, and POST customer-subscriptions/{customer_subscription}/actions/restore reverses it.

Token scope: api:destroy:customer_subscriptions
Without it: 403 insufficient-token-scope.
Permission: customer_subscriptions::delete
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.
Also: Accepts If-Match. 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: Delete a subscription

curl -X DELETE \
  'https://<your-url>/api/v2/customer-subscriptions/1' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/customer-subscriptions/1', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
  },
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->delete('https://<your-url>/api/v2/customer-subscriptions/1');

import requests
response = requests.request(
    'DELETE',
    'https://<your-url>/api/v2/customer-subscriptions/1',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json'},
)

Response

No body.

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

There is no permanent delete: a subscription that has ever been invoiced is referenced by those sales invoices, which is why ?force= is rejected. A deleted subscription is skipped by the renewal run. Its lines are not deleted with it: they stay attached and come back with the subscription when it is restored. Sales invoices already raised from it are untouched and keep pointing at it.

Path parameters

customer_subscriptionintegerRequired

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

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.

Response 204

Returns no content.

Headers

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