SubscriptionTypeItem
One template line on a subscription type: what is sold, how many, at what purchase and sales price, and at what VAT percentage.
- Summary view
- SubscriptionTypeItemList, 17 fields. What a list returns by default.
- Detail view
- SubscriptionTypeItem, 17 fields. The default for a single read and for every write.
A subscription type is a blueprint rather than a live subscription, so these lines bill nothing themselves: they are copied, by value, onto a customer subscription's own lines the moment a type is picked for it. Editing a template line afterwards does not reach the subscriptions already created from it.
Used by
/subscription-types/{subscription_type}/itemsSubscriptionTypeItemList/subscription-types/{subscription_type}/itemsSubscriptionTypeItemFields
- 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 type this template line belongs to. Taken from the path on create and never writable afterwards: a line cannot be moved to another type.
The subscription type this template line belongs to.
The kind of record subscribable points at; it says which branch of subscribable applies.
subscription_product
New values may be added.
The record this template line sells, normally a subscription product. Null on a line that sells nothing in particular, and a bare {"id": N} reference with subscribable_type of domain or server on a line pointed at a hosting record, which only plnnrly itself can do. Expanding it with ?include=subscribable additionally requires subscription_products read permission and a token scope covering that prefix.
Which form you get depends on subscribable_type.
subscription_productSubscriptionProductSummary
Optional label for the template line. plnnrly's form does not show it, so most existing lines carry null; it exists for programmatic naming and is what ?q= searches.
Invoice-line text template, copied verbatim onto the customer subscription's line and resolved only when that line is invoiced. Placeholder tokens survive the copy unresolved: {{$domain}}, {{$period}}, {{$product}}, {{$customer}}, {{$site}}, {{$server}}, plus the Dutch aliases {{$domein}}, {{$periode}} and {{$klant}}.
Number of units the template line carries. Whole units: this is an integer, not the fractional quantity an invoice row uses.
Purchase price per unit, excluding VAT, copied onto a new customer subscription's line.
2 decimal places, may be negative
Sales price per unit, excluding VAT, copied onto a new customer subscription's line. This is what eventually bills.
2 decimal places, may be negative
Position of the line within its subscription type, and the default sort key. Assigned on create; there is no way to reorder template lines through the API.
Variants
SubscriptionTypeItemList 17 fields
What a collection returns, and what ?view=summary returns on a single record.
The same fields as the detail object.
SubscriptionTypeItemSummary 2 fields
The embedded form: what you get when another resource carries this one and you did not include it.
Leaves out: subscription_type_id, subscription_type, subscribable_type, subscribable_id, subscribable, description, quantity, default_purchase_price, default_sales_price, vat_rate, sort_order, created_at, updated_at, deleted_at, links
SubscriptionTypeItemLinks 1 field
The links object on this resource.
Keys: self
Polymorphic fields
subscribableWhich form you get depends on subscribable_type.Something wrong or missing on this page? Tell us