Magidoc

Query
Object

Fields

#

addonAssociatedEntities

AddonAssociatedEntities !
Non-null

Get the latest associated entities of an addon

addons

AddonConnection !
Non-null

aggregatedEventsByCustomer

AggregatedEventsByCustomer !
Non-null

Get aggregated events by customer

cachedEntitlements

[ Entitlement !]!
Non-null

checkoutState

CheckoutState !
Non-null

coupon

Coupon

coupons

CouponConnection !
Non-null

currentEnvironment

String !
Non-null

Fetch the current environment details

currentUser

User !
Non-null

Returns the currently logged in user

customerPortal

CustomerPortal !
Non-null

Customer portal information

customerResources

CustomerResourceConnection !
Non-null

customerSubscriptions

CustomerSubscriptionConnection !
Non-null

customers

CustomerConnection !
Non-null

doesFeatureExist

Boolean !
Non-null

Check if a feature exists

dumpEnvironmentForMergeComparison

DumpEnvironmentForMergeComparison !
Non-null

Dump environment for merge comparison

dumpEnvironmentProductCatalog

ProductCatalogDump !
Non-null

Dump environment product catalog

entitlement

Entitlement !
Non-null

entitlements

[ EntitlementWithSummary !]!
Non-null

environments

EnvironmentConnection !
Non-null

eventLogs

EventLogConnection !
Non-null

eventsFields

EventsFields !
Non-null

Events fields

experiment

Experiment

experiments

ExperimentConnection !
Non-null

featureAssociatedLatestPackages

[ PackageDTO !]!
Non-null

Get the associated latest packages for a feature

features

FeatureConnection !
Non-null

fetchAccount

Account

Fetch the account details

getActiveSubscriptions

[ CustomerSubscription !]!
Non-null

getAddonByRefId

Addon

Get an addon by refId

getAuth0Applications

[ Auth0ApplicationDTO !]!
Non-null

Get Auth0 applications details

getAwsExternalId

GetAwsExternalIdResult !
Non-null

Get AWS external ID

getCustomerByRefId

Customer

Get a customer by slug

getExperimentStats

ExperimentStats !
Non-null

Retrieve statistics for an experiment

getPackageGroup

PackageGroup !
Non-null

Fetching a package group

getPaywall

[ Plan !]!
Non-null

Get paywall by plan ID

getPlanByRefId

Plan

Get plan by reference ID

getSubscription

CustomerSubscription !
Non-null

Get subscription

hook

Hook

hooks

HookConnection !
Non-null

importIntegrationTasks

ImportIntegrationTaskConnection !
Non-null

integrations

IntegrationConnection !
Non-null

listAwsProductDimensions

ListAwsProductDimensionsDTO !
Non-null

List AWS Marketplace product dimensions

listAwsProducts

ListAwsProductsResult !
Non-null

List AWS Marketplace products

members

MemberConnection !
Non-null

mockPaywall

MockPaywall !
Non-null

Get mock paywall by plan ID

packageEntitlements

PackageEntitlementConnection !
Non-null

packageGroup

PackageGroup

packageGroups

PackageGroupConnection !
Non-null

paywall

Paywall !
Non-null

Get paywall by plan ID

plans

PlanConnection !
Non-null

products

ProductConnection !
Non-null

promotionalEntitlements

PromotionalEntitlementConnection !
Non-null

sdkConfiguration

SdkConfiguration

sendTestHook

TestHookResult !
Non-null

Query to get the result of sending a test webhook event

stripeCustomers

StripeCustomerSearchResult !
Non-null

List Stripe customers

stripeProducts

StripeProductSearchResult !
Non-null

List Stripe products

stripeSubscriptions

StripeSubscriptionSearchResult !
Non-null

List Stripe subscriptions

subscriptionEntitlements

SubscriptionEntitlementConnection !
Non-null

subscriptionMigrationTasks

SubscriptionMigrationTaskConnection !
Non-null

testHookData

TestHook !
Non-null

Query to get the payload for a test webhook event

triggerWorkflowWithTestEvent

TriggerWorkflowDTO !
Non-null

Trigger a workflow with test event

usageEvents

UsageEventsPreview !
Non-null

Get usage events

usageHistory

UsageHistory !
Non-null

Get usage istory

usageHistoryV2

UsageHistoryV2 !
Non-null

Get customer's usage history for a feature

usageMeasurements

UsageMeasurementConnection !
Non-null

validateMergeEnvironment

ValidateMergeEnvironment !
Non-null

Validate that one environment can be merged into another

verifiedAccountDomains

[ String !]!
Non-null

Returns a list of email-domains of verified account members

widgetConfiguration

WidgetConfiguration !
Non-null

workflowTriggers

[ WorkflowTriggerDTO !]!
Non-null

Get all workflow triggers