Magidoc

AccountServicePlan
Object

Account plan for a specific service type. Only one active plan per service type is allowed.

Fields

#

account

GlobalAccount

Account

accountId

Long !
Non-null

ID of the account

autoRefillCreditItemId

Long !
Non-null

ID of credit block to automatically purchase when account credit balance is equal to or below MinimumCredits

createdBy

String

Id of user who created the service plan

createdUtc

DateTime !
Non-null

Date/time the service plan was created

currentBillEndUtc

DateTime !
Non-null

End date/time of current billing period

currentBillStartUtc

DateTime !
Non-null

Start date/time of current billing period

id

Long !
Non-null

Unique account plan ID

isActive

Boolean !
Non-null

Indicates whether account plan is active

isPrepay

Boolean !
Non-null

Indicates whether the plan is Pay-As-You-Go

minimumCredits

Float !
Non-null

Minimum credit balance that will trigger more credits to be automatically purchased

modifiedBy

String

Id of user who last modified the service plan

modifiedUtc

DateTime !
Non-null

Date/time the service plan was last modified

nextBillUtc

DateTime !
Non-null

Start date/time of next billing period

nextPlanCreditItemId

Long !
Non-null

ID of credit block to be purchased when downgrading from a scale-based plan to credit-based plan

nextPlanId

Long !
Non-null

ID of next plan when downgrading plans

servicePlan

ServicePlanDto

Service plan

servicePlanId

Long !
Non-null

ID of the service plan

startUtc

DateTime !
Non-null

Date/time the plan started

trialEndUtc

DateTime

Date/time that the trial plan will end at which time a new plan much be selected for the account to remain active.

Usages

#

References

#