Read a subscription line

GEThttps://<your-url>/api/v2/subscription-items/{subscription_item}

MCP id subscription-items.showAlso on this path: PATCH Update a subscription line, DELETE Delete a subscription line

Returns one subscription line in the detail view.

Token scope: api:read:customer_subscriptions
Without it: 403 insufficient-token-scope.
Permission: customer_subscriptions::read
Without it: 403 insufficient-permission.
Feature: Needs the billing feature on your organisation.
Without it: 404 endpoint-not-found.
Rate cost: 1 unit, read bucket.
Also: If-None-Match answers 304 when nothing changed. 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: One line with its product expanded

curl -G \
  'https://<your-url>/api/v2/subscription-items/1' \
  --data-urlencode 'include=subscribable' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/subscription-items/1?include=subscribable', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
  },
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->get('https://<your-url>/api/v2/subscription-items/1?include=subscribable');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/subscription-items/1?include=subscribable',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json'},
)

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": "…",
    "quantity": 1,
    "purchase_price": "1250.00",
    "sales_price": "1250.00",
    "vat_rate": 1,
    "vat_amount": "1250.00"
  }
}

10 more fields, listed under Response

The description is published exactly as stored, with any {{$domain}}-style placeholders unresolved: those are filled in only when a renewal turns the line into an invoice row. Lines are soft-deleted, so a deleted line is 404 unless trashed=with or trashed=only is passed; trashed=only 404s a live line. This flat path performs no lookup of the parent subscription: a line is readable by id to any caller holding customer_subscriptions::read, which is what plnnrly does too.

Path parameters

subscription_itemintegerRequired

The SubscriptionItem'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-None-Matchstring

The ETag a read is conditional on. A match is answered 304 with no body.

Response 200

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

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.

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

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.

created_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Creation timestamp.

updated_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Last-write timestamp; use for incremental sync. This is also the ETag revision: a subscription line has no version field.