Magidoc

Plan
Object

Plan Data Transfer Object

Fields

#

additionalMetaData

The additional meta data of the package

awsMarketplacePlanDimension

The AWS Marketplace plan dimension, if applicable

basePlan

billingId

The unique identifier for the entity in the billing provider

billingLinkUrl

The billing link url of the package

compatibleAddons

[ Addon !]

compatiblePackageGroups

List of compatible package groups for the plan

createdAt

Timestamp of when the record was created

defaultTrialConfig

Default trial configuration for the plan

description

The description of the package

displayName

Non-null

The display name of the package

draftDetails

Detailed information about the plan draft

draftSummary

Summary of the plan draft

entitlements

List of entitlements for the plan

environment

Non-null

environmentId

Non-null

The unique identifier for the environment

hiddenFromWidgets

List of hidden widgets of the package

id

Non-null

Unique identifier for the entity

inheritedEntitlements

List of inherited entitlements for the plan

isLatest

Indicates if the package is the latest version

isParent

Non-null

Indicates if the plan is a parent plan

minimumSpend

Minimum spend configuration

overageBillingPeriod

The overage billing period of the package

overagePrices

[ Price !]

List of overage prices of the package

prices

[ Price !]

List of prices for the plan

pricingType

The pricing type of the package

product

Non-null

productId

The product id of the package

refId

Non-null

The unique identifier for the entity

status

Non-null

The status of the package

syncStates

Sync states of the plan with external systems

type

Non-null

The type of the package

updatedAt

Timestamp of when the record was last updated

versionNumber

Non-null

The version number of the package

Usages

#

References

#