Add a line to a subscription

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

MCP id customer-subscriptions.items.storeAlso on this path: GET List a subscription's lines

Creates one line on the subscription 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:customer_subscriptions
Without it: 403 insufficient-token-scope.
Permission: customer_subscriptions::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 hosting line billing a subscription product

curl -X POST \
  'https://<your-url>/api/v2/customer-subscriptions/1/items' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: <key>' \
  -d '{
    "description": "Webhosting {{$domain}}",
    "quantity": 1,
    "purchase_price": "4.50",
    "sales_price": "12.50",
    "subscribable_type": "subscription_product",
    "subscribable_id": 1
  }'

const response = await fetch('https://<your-url>/api/v2/customer-subscriptions/1/items', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Idempotency-Key': '<key>',
  },
  body: JSON.stringify({
    "description": "Webhosting {{$domain}}",
    "quantity": 1,
    "purchase_price": "4.50",
    "sales_price": "12.50",
    "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/customer-subscriptions/1/items', [
        'description' => 'Webhosting {{$domain}}',
        'quantity' => 1,
        'purchase_price' => '4.50',
        'sales_price' => '12.50',
        'subscribable_type' => 'subscription_product',
        'subscribable_id' => 1,
    ]);

import requests
response = requests.request(
    'POST',
    'https://<your-url>/api/v2/customer-subscriptions/1/items',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json', 'Content-Type': 'application/json', 'Idempotency-Key': '<key>'},
    json={'description': 'Webhosting {{$domain}}', 'quantity': 1, 'purchase_price': '4.50', 'sales_price': '12.50', 'subscribable_type': 'subscription_product', 'subscribable_id': 1},
)

Response

The shape of the response, with sample values.

{
  "data": {
    "id": 1,
    "customer_subscription_id": 1,
    "customer_subscription": {
      "id": 1
    },
    "subscribable_type": "subscription_product",
    "subscribable_id": 1,
    "subscribable": null,
    "description": "Webhosting {{$domain}}",
    "quantity": 1,
    "purchase_price": "4.50",
    "sales_price": "12.50",
    "vat_rate": 1,
    "vat_amount": "1250.00"
  }
}

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

10 more fields, listed under Response

The subscription comes from the path, so customer_subscription_id is not accepted in the body and a line can never be moved between subscriptions. sort_order is assigned by the server and appends the line to the end. vat_amount and total_amount are computed by the server from quantity, sales_price and vat_rate and are never accepted; note that total_amount includes VAT here, unlike a sales-invoice row. subscribable_type and subscribable_id are sent together or not at all, and subscription_product is the only type this API can attach: lines that bill a hosting domain or a server can be created in plnnrly only. A deleted subscription answers 404. exact_item_id and the other Exact codes are optional: a renewal falls back to the product's own Exact values and then to the organisation's defaults.

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

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.

descriptionstring or null

The line text, as printed on the invoice a renewal generates. May contain placeholders such as {{$domain}}; the API publishes the raw stored text and those are resolved only at invoice time.

quantityinteger≥ 1

Number of units billed per period.

purchase_pricedecimal (2 dp)0 to 99999999.99

Cost price per unit, for margin bookkeeping only. It feeds neither generated amount below and appears on no invoice.

2 decimal places, not negative

At least 0. At most 99999999.99.

sales_pricedecimal (2 dp)0 to 99999999.99

Sales price per unit, excluding VAT. This is what actually bills: a renewal copies it into the generated invoice row's unit price.

2 decimal places, not negative

At least 0. At most 99999999.99.

vat_rateinteger0 to 100

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

subscribable_typestring or null

What this line sells. Rendered as {"id": N} until named in ?include=subscribable, which additionally requires the read permission and token scope of the subscription_products prefix. Lines that bill a hosting domain or a server carry a subscribable_type this API publishes no shape for, and keep the {"id": N} form however they are requested; identify those from subscribable_type and subscribable_id yourself. Null on both halves is a free-text line priced by hand.

Required when subscribable_id is present.

subscription_product

subscribable_idinteger or null → SubscriptionProduct.id

Required when subscribable_type is present.

exact_item_idstring or null≤ 255

Exact Online article identifier this line bills against. Optional: a renewal falls back to the subscription product's own Exact values and then to the organisation's Exact defaults, so leaving it empty does not break the sync.

exact_vat_codestring or null≤ 255

Exact Online VAT code, by code rather than by id.

exact_gl_accountstring or null≤ 255

Exact Online general-ledger revenue account for this line.

exact_cost_centerstring or null≤ 255

Exact Online cost-centre code.

Response 201

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

customer_subscription_idintegerServer-assigned

The subscription this line belongs to. Taken from the path on create and never writable afterwards: a line cannot be moved to another subscription.

customer_subscriptionRef or CustomerSubscriptionSummary

The subscription this 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

descriptionstring or nullMultiline

The line text, as printed on the invoice a renewal generates. May contain placeholders such as {{$domain}}; the API publishes the raw stored text and those are resolved only at invoice time.

quantityinteger

Number of units billed per period.

purchase_pricedecimal (2 dp)≥ 0

Cost price per unit, for margin bookkeeping only. It feeds neither generated amount below and appears on no invoice.

2 decimal places, not negative

sales_pricedecimal (2 dp)≥ 0

Sales price per unit, excluding VAT. This is what actually bills: a renewal copies it into the generated invoice row's unit price.

2 decimal places, not negative

vat_rateinteger

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

vat_amountdecimal (2 dp)Server-assigned

VAT on this line, computed by the server: quantity x sales_price x vat_rate / 100. Read-only.

2 decimal places, may be negative

total_amountdecimal (2 dp)Server-assigned

Line total including VAT (quantity x sales_price plus the VAT above), computed by the server. Note this is the opposite convention from SalesInvoiceRow.total_amount, which excludes VAT: adding VAT to this value double-counts it. Read-only.

2 decimal places, may be negative

sort_orderintegerServer-assigned

Position of the line within its subscription, and the default sort key. Assigned on create; there is no way to reorder lines through the API. Only the ordering is meaningful: values are not unique across subscriptions.

exact_item_idstring or null≤ 255