List a subscription's lines

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

MCP id customer-subscriptions.items.indexAlso on this path: POST Add a line to a subscription

Returns one customer subscription's lines in their printed order, sort_order ascending.

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. view=detail makes it 3. Adds: each include +1, q +2.
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 subscription's lines, including its deleted ones

curl -G \
  'https://<your-url>/api/v2/customer-subscriptions/1/items' \
  --data-urlencode 'trashed=with' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/customer-subscriptions/1/items?trashed=with', {
  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/customer-subscriptions/1/items?trashed=with');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/customer-subscriptions/1/items?trashed=with',
    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": "Webhosting {{$domain}}",
      "quantity": 1,
      "purchase_price": "4.50",
      "sales_price": "12.50",
      "vat_rate": 1,
      "vat_amount": "1250.00"
    }
  ],
  "meta": {
    "page": {
      "per_page": 1,
      "next_cursor": "…",
      "prev_cursor": "…",
      "total": 1,
      "current_page": 1,
      "last_page": 1
    }
  },
  "links": {
    "self": "https://<your-url>/api/v2/work-items/1",
    "next": "https://<your-url>/api/v2/work-items/1",
    "prev": "https://<your-url>/api/v2/work-items/1"
  }
}

10 more fields, listed under Response

There is no organisation-wide collection of subscription lines: a line only means anything under the subscription it belongs to, so this nested path is the only way to list them and filter[customer_subscription_id] does not exist. A deleted subscription answers 404 for the whole path unless trashed=with is passed, which also includes the subscription's deleted lines. Defaults to the summary view; pass include=customer_subscription or include=subscribable to expand what each line points at.

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.

18 parameters in 7 groups

Views

viewstring

Which field set to render.

summarydefaultdetail

Pagination

per_pageinteger1 to 100

Rows per page. At most 25 when include names a to-many relation; a larger value is 400 invalid-query-parameter.

Default: 25

cursorstring

Opaque keyset cursor from a previous page's links.next. Never construct one by hand.

pageinteger1 to 1000

Opt in to page-number paging: 1-based, at most 1000. Omit it, the default, to page by opaque cursor, which is what links.next hands you. Cannot be combined with cursor. Published only on collections that count their rows on every request. This collection's default sort is a display position that changes whenever someone drags the list into a new order in plnnrly, so a page number can skip or repeat a row if the list is reordered between two page requests. These collections rarely exceed one page; for a stable walk, send sort=id and follow links.next without page.

Filters

=: equals
[in]: any of a comma-separated list
[null]: true or false: whether it is empty
[gte][lt]: at least, less than

filter[created_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lt]

Creation timestamp. Pair with sort=id for a stable full export.

filter[subscribable_id]integer=[in][null]

Id of the record this line sells. Send together with subscribable_type.

A comma-separated list of at most 100 values.

filter[subscribable_type]string

What kind of record this line sells. Send together with subscribable_id.

filter[updated_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lt]

Last-write timestamp. Use for incremental sync.

Search

qstring

Free-text search over description. At most one substring match per request: q together with a contains filter is 400 invalid-query-parameter.

Sorting

sortstring

Up to three keys, comma-separated, each optionally prefixed with - for descending.

Default: sort_order

Key	Sorts by
`sort_order`	Position of the line within its subscription, first to last.
`id`	Id, ascending. An id never changes, so use this for a stable full export.
`updated_at`	Last-write timestamp; pair with the id tiebreaker for sync.

Prefix a key with - for descending.

Includes

includestring

Comma-separated names to inline, at most five.

Path	Adds	Cost
`customer_subscription`	The subscription this line belongs to.	+1
`subscribable`	The subscription product this line charges for.	+1

Other

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 page of SubscriptionItemList rows.

dataarray of SubscriptionItemList

The rows, each a SubscriptionItemList.

meta.pagePage

per_page, next_cursor, prev_cursor, total, current_page, last_page.

linksPageLinks

self, next, prev.

Each row is a SubscriptionItemList: 22 fields.

Headers

ETag: A weak validator (W/"…") of the rendered page.
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.