Magidoc

Addon
Object

Addon

Fields

#

additionalMetaData

JSON

The additional meta data of the package

billingId

String

The unique identifier for the entity in the billing provider

billingLinkUrl

String

The billing link url of the package

createdAt

DateTime

Timestamp of when the record was created

dependencies

[ Addon !]

List of addons the addon is dependant on

description

String

The description of the package

displayName

String !
Non-null

The display name of the package

draftDetails

PackageDraftDetails

Draft details for the addon

draftSummary

PackageDraftSummary

Draft summary for the addon

entitlements

[ PackageEntitlement !]

List of entitlements for the addon

environment

Environment !
Non-null

environmentId

UUID !
Non-null

The unique identifier for the environment

hasSubscriptions

Boolean !
Non-null

Indicates if the addon has subscriptions

hiddenFromWidgets

[ WidgetType !]

List of hidden widgets of the package

id

UUID !
Non-null

Unique identifier for the entity

isLatest

Boolean

Indicates if the package is the latest version

maxQuantity

Float

The maximum quantity of this addon that can be added to a subscription

overageBillingPeriod

OverageBillingPeriod

The overage billing period of the package

overagePrices

[ Price !]

List of overage prices of the package

prices

[ Price !]

pricingType

PricingType

The pricing type of the package

product

Product

productId

String

The product id of the package

refId

String !
Non-null

The unique identifier for the entity

status

PackageStatus !
Non-null

The status of the package

syncStates

[ SyncState !]

List of sync states for the addon

type

String !
Non-null

The type of the package

updatedAt

DateTime

Timestamp of when the record was last updated

versionNumber

Int !
Non-null

The version number of the package

Usages

#

References

#

  • Field dependencies from Addon