Magidoc

ServicePlanDto
Object

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

Fields

#

accountInvoiceLineItems

[AccountInvoiceLineItem ]

Collection of Account invoice line items

accountServicePlans

[AccountServicePlan ]

Collection of Account service plans

createdBy

String

Id of user who created the service plan

createdUtc

DateTime !
Non-null

Date/time the service plan was created

creditValue

Float !
Non-null

Non-monetary value of each credit

credits

[ServicePlanCredit ]

Collection of credit blocks

description

String

Description of service plan

displayOrder

Int !
Non-null

Order of which the service plan is displayed

features

[ServicePlanFeatureDto ]

Collection of features

id

Long !
Non-null

Unique service plan ID

internalPlanName

String

Unique internal service plan name

internalUseOnly

Boolean !
Non-null

Plan is for internal/admin use only and hidden from the public catalog

isActive

Boolean !
Non-null

Indicates whether service plan is active

isPublic

Boolean !
Non-null

Indicates whether service plan is displayed on websites/applications

isTrial

Boolean !
Non-null

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

modifiedBy

String

Id of user who last modified the service plan

modifiedUtc

DateTime !
Non-null

Date/time the service plan was last modified

period

Int !
Non-null

Number of period units per billing cycle

periodType

Int !
Non-null

Period type: 1=Day, 2=Week, 3=Month, 4=Year

planName

String

Unique name of service plan

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

scales

[ServicePlanScale ]

Collection of scales

serviceType

ServiceType !
Non-null

Service type associated with the plan

trialDays

Int !
Non-null

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

Usages

#

References

#