maas-schemas

subscriptionOption Schema

http://maasglobal.com/maas-backend/subscriptions/subscriptionOption.json

MaaS subscription option schema

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	Yes	Develop	No	Forbidden	Permitted	maas-backend/subscriptions/subscriptionOption.json

Schema Hierarchy

• subscriptionOption http://maasglobal.com/maas-backend/subscriptions/subscriptionOption.json
  • subscription http://maasglobal.com/maas-backend/subscriptions/subscription.json

subscriptionOption Properties

Property	Type	Required	Nullable	Defined by
active	boolean	Optional	No	subscription
addons	addon	Optional	No	subscription
availability	object	Optional	No	subscription
changeState	subscriptionChangeState	Optional	No	subscription
coupons	coupon	Optional	No	subscription
customerId	identityId	Optional	No	subscription
description	string	Optional	No	subscription
discounts	array	Optional	No	subscriptionOption (this schema)
hidden	boolean	Optional	No	subscription
id	identityId	Optional	No	subscription
level	integer	Optional	No	subscription
meta	object	Optional	No	subscription
name	string	Optional	No	subscription
plan	object	Optional	No	subscription
pointCost	point-cost	Optional	No	subscription
region	region	Optional	No	subscription
regionDefault	boolean	Required	No	subscriptionOption (this schema)
requiredAuthorizations	agencyId	Required	No	subscriptionOption (this schema)
selectable	boolean	Optional	No	subscription
shippingAddress	subscriptionAddress	Optional	No	subscription
terms	object	Optional	No	subscription
topUpId	string	Optional	No	subscription
wmpGrant	integer	Optional	No	subscription
*	any	Additional	Yes	this schema allows additional properties

active

active

• is optional
• type: boolean
• defined in subscription

active Type

boolean

addons

addons

• is optional
• type: addon
• defined in subscription

addons Type

Array type: addon

All items must be of the type:

• addon – #/definitions/addon

availability

availability

• is optional
• type: object
• defined in subscription

availability Type

object with following properties:

| Property | Type | Required | | ——– | —- | ——– |

changeState

changeState

• is optional
• type: subscriptionChangeState
• defined in subscription

changeState Type

• subscriptionChangeState – http://maasglobal.com/core/components/subscriptionChangeState.json

coupons

coupons

• is optional
• type: coupon
• defined in subscription

coupons Type

Array type: coupon

All items must be of the type:

• coupon – #/definitions/coupon

customerId

customerId

• is optional
• type: identityId
• defined in subscription

customerId Type

• identityId – http://maasglobal.com/core/components/units.json#/definitions/identityId

description

description

• is optional
• type: string
• defined in subscription

description Type

string

discounts

discounts

• is optional
• type: array
• defined in this schema

discounts Type

Array type: array

hidden

hidden

• is optional
• type: boolean
• defined in subscription

hidden Type

boolean

id

id

• is optional
• type: identityId
• defined in subscription

id Type

• identityId – http://maasglobal.com/core/components/units.json#/definitions/identityId

level

level

• is optional
• type: integer
• defined in subscription

level Type

integer

• minimum value: 1

meta

Arbitrary metadata on whatever app might need to display

meta

• is optional
• type: object
• defined in subscription

meta Type

object with following properties:

| Property | Type | Required | | ——– | —- | ——– |

name

name

• is optional
• type: string
• defined in subscription

name Type

string

• minimum length: 2 characters

plan

Customer subscription plan

plan

• is optional
• type: object
• defined in subscription

plan Type

object with following properties:

Property	Type	Required
description	string	Optional
id		Required
name	string	Optional
price		Optional

description

description

• is optional
• type: string

description Type

string

id

id

• is required
• type: subscriptionItemId

id Type

• subscriptionItemId – #/definitions/subscriptionItemId

name

name

• is optional
• type: string

name Type

string

• minimum length: 1 characters

price

price

• is optional
• type: price

price Type

• price – #/definitions/price

pointCost

pointCost

• is optional
• type: point-cost
• defined in subscription

pointCost Type

• point-cost – http://maasglobal.com/core/components/point-cost.json

region

region

• is optional
• type: region
• defined in subscription

region Type

• region – http://maasglobal.com/core/region.json

regionDefault

Is this subscription option the default one for the region

regionDefault

• is required
• type: boolean
• defined in this schema

regionDefault Type

boolean

requiredAuthorizations

Authorizations needed for the user before this subscription can be fulfilled

requiredAuthorizations

• is required
• type: agencyId
• at least 0 items in the array
• defined in this schema

requiredAuthorizations Type

Array type: agencyId

All items must be of the type: string

• minimum length: 2 characters
• maximum length: 64 characters

selectable

selectable

• is optional
• type: boolean
• defined in subscription

selectable Type

boolean

shippingAddress

shippingAddress

• is optional
• type: subscriptionAddress
• defined in subscription

shippingAddress Type

• subscriptionAddress – http://maasglobal.com/maas-backend/subscriptions/subscriptionAddress.json

terms

Terms related to this subscription

terms

• is optional
• type: object
• defined in subscription

terms Type

object with following properties:

Property	Type	Required	Default
activated		Optional
modified		Optional
scheduledChanges	boolean	Optional	false
validity	object	Required

activated

activated

• is optional
• type: time

activated Type

• time – http://maasglobal.com/core/components/units.json#/definitions/time

modified

modified

• is optional
• type: time

modified Type

• time – http://maasglobal.com/core/components/units.json#/definitions/time

scheduledChanges

scheduledChanges

• is optional
• type: boolean
• default: false

scheduledChanges Type

boolean

validity

Subscription validity conditions

validity

• is required
• type: object

validity Type

object with following properties:

Property	Type	Required
endTime		Required
startTime		Required

endTime

endTime

• is required
• type: time

endTime Type

• time – http://maasglobal.com/core/components/units.json#/definitions/time

startTime

startTime

• is required
• type: time

startTime Type

• time – http://maasglobal.com/core/components/units.json#/definitions/time

topUpId

topUpId

• is optional
• type: string
• defined in subscription

topUpId Type

string

• minimum length: 2 characters

wmpGrant

wmpGrant

• is optional
• type: integer
• defined in subscription

wmpGrant Type

integer

• minimum value: 0

All of the following requirements need to be fulfilled.

Requirement 1

• subscriptionBase – http://maasglobal.com/maas-backend/subscriptions/subscription.json#/definitions/subscriptionBase

Requirement 2

• subscriptionAdditions – #/definitions/subscriptionAdditions

This site is open source. Improve this page.