Subscription

Type: object

ONBRDNG Schema for a Subscription

root id
Type: string

Unique Identifier for a Subscription

root name
Type: string

The Subscription Name

root payment_amount
Type: number

Subscription price per payment period

root payment_period
Type: string

Payment period. Format: ISO-8601 {P}[n]Y[n]M[n]D|P[n]W.

Must match regular expression: ^P(\d+Y)?(\d+M)?(\d+D)?(T(\d+H)?(\d+M)?(\d+(\.\d+)?S)?)?$

root discount_payment_amount
Type: number

Discount Subscription price for the duraction of discount_duration

root discount_duration
Type: string

Discount duration period. Format: ISO-8601 {P}[n]Y[n]M[n]D|P[n]W.

Must match regular expression: ^P(\d+Y)?(\d+M)?(\d+D)?(T(\d+H)?(\d+M)?(\d+(\.\d+)?S)?)?$

root trial_duration
Type: string

Trial duration period without payment. Format: ISO-8601 {P}[n]Y[n]M[n]D|P[n]W.

Must match regular expression: ^P(\d+Y)?(\d+M)?(\d+D)?(T(\d+H)?(\d+M)?(\d+(\.\d+)?S)?)?$

root term
Type: string

The duration of the contractual term. Format: ISO-8601 {P}[n]Y[n]M[n]D|P[n]W.

Must match regular expression: ^P(\d+Y)?(\d+M)?(\d+D)?(T(\d+H)?(\d+M)?(\d+(\.\d+)?S)?)?$

root currency
Type: string

Pricing currency. Format: ISO-4217, ie 'GBP'

Must match regular expression: ^[A-Z]{3}$

root features
Type: array of string

List of Subscription features

Each item of this array must be:

root features features items
Type: string

root active
Type: boolean

The Subscription active state.

root notes
Type: string

The Subscription notes, ie 'first time trial, reseller subscription, etc'.

root contract_type
Type: enum (of string)

The type of contract, ie 'fixed term, evergreen'

Must be one of:

  • "fixed term"
  • "evergreen"

root available_from
Type: stringFormat: date-time

Moment of User Subscription availability. Format: YYYY-MM-DD HH:MM:SS[.SSSSSS].

Must match regular expression: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?Z?$

root available_to
Type: stringFormat: date-time

Moment of User end Subscription availability. Format: YYYY-MM-DD HH:MM:SS[.SSSSSS].

Must match regular expression: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?Z?$