Magidoc

ServicePlanDto
Object

Plan based on a service type that can be available to accounts

Fields

#

id

Long !
Non-null

Unique service plan ID

planName

String

Unique name of service plan

internalPlanName

String

Unique internal service plan name

description

String

Description of service plan

isTrial

Boolean !
Non-null

Indicates whether service plan is a trial plan. Only one service plan can be a trail per service type

trialDays

Int !
Non-null

Number of days a trial plan can be used before an upgrade is required

displayOrder

Int !
Non-null

Order of which the service plan is displayed

rank

Float !
Non-null

Determines the perceived value of the service plan used to determine if the plan is an upgrade/downgrade from another service plan

creditValue

Float !
Non-null

Non-monetary value of each credit

serviceType

ServiceType !
Non-null

Service type associated with the plan

isPublic

Boolean !
Non-null

Indicates whether service plan is displayed on websites/applications

isActive

Boolean !
Non-null

Indicates whether service plan is active

createdUtc

DateTime !
Non-null

Date/time the service plan was created

createdBy

String

Id of user who created the service plan

modifiedUtc

DateTime !
Non-null

Date/time the service plan was last modified

modifiedBy

String

Id of user who last modified the service plan

features

[ ServicePlanFeatureDto ]

Collection of features

scales

[ ServicePlanScale ]

Collection of scales

credits

[ ServicePlanCredit ]

Collection of credit blocks

accountServicePlans

[ AccountServicePlan ]

Collection of Account service plans

accountInvoiceLineItems

[ AccountInvoiceLineItem ]

Collection of Account invoice line items

Usages

#

References

#