SubscriptionItem
One line on a customer subscription: what is being sold, how many, at what purchase and sales price, and at what VAT percentage.
- Summary view
- SubscriptionItemList, 22 fields. What a list returns by default.
- Detail view
- SubscriptionItem, 22 fields. The default for a single read and for every write.
These lines are what a renewal turns into sales-invoice rows, and a subscription with no lines cannot be invoiced.
Used by
/customer-subscriptions/{customer_subscription}/itemsSubscriptionItemList/customer-subscriptions/{customer_subscription}/itemsSubscriptionItemFields
- Detail only
- Only in the detail view.
- Only with include
- Only when you ask for it with include.
- Server-assigned
- Set by plnnrly, never by a request.
The subscription this line belongs to. Taken from the path on create and never writable afterwards: a line cannot be moved to another subscription.
The subscription this line belongs to.
The kind of record subscribable points at; it says which branch of subscribable applies.
subscription_product
New values may be added.
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_productSubscriptionProductSummary
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.
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 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 on this line, computed by the server: quantity x sales_price x vat_rate / 100. Read-only.
2 decimal places, may be negative
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
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 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.
Last-write timestamp; use for incremental sync. This is also the ETag revision: a subscription line has no version field.
Variants
SubscriptionItemList 22 fields
What a collection returns, and what ?view=summary returns on a single record.
The same fields as the detail object.
SubscriptionItemSummary 2 fields
The embedded form: what you get when another resource carries this one and you did not include it.
Leaves out: customer_subscription_id, customer_subscription, subscribable_type, subscribable_id, subscribable, quantity, purchase_price, sales_price, vat_rate, vat_amount, total_amount, sort_order, exact_item_id, exact_vat_code, exact_gl_account, exact_cost_center, created_at, updated_at, deleted_at, links
SubscriptionItemLinks 1 field
The links object on this resource.
Keys: self
Polymorphic fields
subscribableWhich form you get depends on subscribable_type.Columns deliberately not published
resource_idThe other half of that pair, withheld with it.resource_typeThe hosting site or server a line is sold for has no published shape in this API, so it is not exposed.Something wrong or missing on this page? Tell us