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

SubscriptionType

SubscriptionType

A subscription type: the organisation's hand-maintained template a customer subscription is instanced from, carrying the default billing interval and renewal behaviour new subscriptions start with.

View as Markdown
Summary view
SubscriptionTypeList, 12 fields. What a list returns by default.
Detail view
SubscriptionType, 12 fields. The default for a single read and for every write.
Read with
api:read:subscription_typesandsubscription_types::read
Write with
api:write:subscription_typesandsubscription_types::create

Its template lines live on the items sub-resource, and the type's name is the name plnnrly shows for every subscription of that type.

Used by

GETList subscription types/subscription-typesSubscriptionTypeList
POSTCreate a subscription type/subscription-typesSubscriptionType
GETRead a subscription type/subscription-types/{subscription_type}SubscriptionType
PATCHUpdate a subscription type/subscription-types/{subscription_type}SubscriptionType
POSTRestore a deleted subscription type/subscription-types/{subscription_type}/actions/restoreSubscriptionType

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

Subscription type name. It is also the name every customer subscription of this type is displayed under, so renaming a type renames what its existing subscriptions read as. Names are not unique.

descriptionstring or nullMultiline

What subscriptions of this type cover, as free text.

default_billing_intervalstring

Interval a new subscription of this type is billed at by default. Omitting it on create yields yearly, the stored default, not the monthly that plnnrly's form pre-selects, which is a form convenience the API deliberately does not reproduce.

yearlymonthlyone-time

New values may be added.

auto_renewboolean

Whether subscriptions created from this type renew automatically by default. The value is stored exactly as sent; nothing forces it to false.

activeboolean

Whether the type is offered in the catalogue. It is a catalogue flag only: nothing in the application filters on it, so deactivating a type does not stop existing subscriptions of that type from being renewed or invoiced.

sort_orderinteger or nullServer-assigned

Position in the catalogue, assigned by the server on create as one past the highest existing position. It is the default sort key, and there is no way to reorder types through the API: dragging types into order in plnnrly has no API equivalent in v2.0.

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

Creation timestamp.

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

Last-write timestamp; use for incremental sync. It also feeds the ETag revision, because a subscription type has no version field.

deleted_attimestamp (YYYY-MM-DDThh:mm:ssZ) or null

Soft-delete timestamp, null while live.

items_countinteger≥ 0

Number of template lines on this subscription type.

Variants

SubscriptionTypeList 12 fields

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

The same fields as the detail object.

SubscriptionTypeSummary 2 fields

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

Leaves out: description, default_billing_interval, auto_renew, active, sort_order, created_at, updated_at, deleted_at, items_count, links

SubscriptionTypeLinks 2 fields

The links object on this resource.

Keys: self, items