plnnrlydevelopers

Deze referentie is alleen in het Engels. Naar het Nederlandse REST API-overzicht

Diese Referenz gibt es nur auf Englisch. Zur deutschen REST-API-Übersicht

Cette référence existe uniquement en anglais. Aller à la présentation de l'API REST en français

Esta referencia solo está en inglés. Ir a la introducción de la API REST en español

SubscriptionProduct

SubscriptionProduct

A sellable subscription product: the organisation's hand-maintained catalogue of what a customer subscription or a subscription type can bill for.

View as Markdown
Summary view
SubscriptionProductList, 15 fields. What a list returns by default.
Detail view
SubscriptionProduct, 15 fields. The default for a single read and for every write.
Read with
api:read:subscription_productsandsubscription_products::read
Write with
api:write:subscription_productsandsubscription_products::create

Subscription lines point at a product and inherit its price, interval and VAT rate.

Used by

GETList subscription products/subscription-productsSubscriptionProductList
POSTCreate a subscription product/subscription-productsSubscriptionProduct
GETRead a subscription product/subscription-products/{subscription_product}SubscriptionProduct
PATCHUpdate a subscription product/subscription-products/{subscription_product}SubscriptionProduct
POSTRestore a deleted subscription product/subscription-products/{subscription_product}/actions/restoreSubscriptionProduct

Fields

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.
idinteger

Unique identifier.

namestring≤ 255

Product name as shown in the UI and on the subscription line.

descriptionstring or nullMultiline

Invoice-line template for subscription lines built from this product. Supports the placeholder tokens {{$domain}}, {{$site}}, {{$server}}, {{$period}}, {{$product}} and {{$customer}}, which are filled in when the line is invoiced; the template itself is kept verbatim.

purchase_pricedecimal (2 dp) or null

What the product costs us, as a decimal string. Null when unknown.

2 decimal places, may be negative

sales_pricedecimal (2 dp) or null

What the customer is billed per interval, as a decimal string. Null when the line carries its own price.

2 decimal places, may be negative

price_intervalstring

Interval the sales price is charged per.

yearlymonthlyone-time

New values may be added.

is_hostingboolean

Whether this is a hosting product: one sold against a concrete site or server, which is what lets a subscription line name the infrastructure it covers.

vat_rateinteger or null

VAT rate as a whole percentage: 21 means 21%, not 0.21. Null when the rate is decided at invoicing time.

exact_item_idstring or null≤ 255

Exact Online article this product maps to, by Exact's own external identifier (exact_items.exact_id), not by a local id.

exact_vat_codestring or null≤ 255

Exact Online VAT code, by code (exact_vat_codes.code), not by id.

Variants

SubscriptionProductList 15 fields

What a collection returns, and what ?view=summary returns on a single record.

The same fields as the detail object.

SubscriptionProductSummary 2 fields

The embedded form: what you get when another resource carries this one and you did not include it.

Leaves out: description, purchase_price, sales_price, price_interval, is_hosting, vat_rate, exact_item_id, exact_vat_code, exact_cost_center, created_at, updated_at, deleted_at, links

SubscriptionProductLinks 1 field

The links object on this resource.

Keys: self