Magidoc

Mutation
Object

Fields

#

addCompatibleAddonsToPlan

Non-null

applySubscription

Non-null

archiveAddon

Non-null

Archive an addon by refId

archiveCustomer

Non-null

Archive a customer

archiveEnvironment

Non-null

Archive an environment

archiveFeature

Non-null

Archive a feature

archiveOneCoupon

Non-null

archivePackageGroup

Non-null

Archiving a package group

archivePlan

Non-null

Archive a plan

attachCustomerPaymentMethod

Non-null

Attach a payment method to a customer

cancelSchedule

Non-null

cancelSubscription

Non-null

chargeSubscriptionUsage

Non-null

Immediately charges usage in the given subscription

createAccount

Non-null

Create a new account

createAddonDraft

Non-null

Create a draft addon from an addon by id

createEmptyAddonDraft

Non-null

Create an empty draft addon from an addon by id

createEmptyPlanDraft

Non-null

Create an empty plan draft

createFeature

Non-null

Create a new feature

createManyPackageEntitlements

Non-null

createManyPromotionalEntitlements

Non-null

createOneAddon

Non-null

Create an addon

createOneCoupon

Non-null

createOneCustomer

Non-null

Create a new customer

createOneEnvironment

Non-null

Create a new environment

createOneExperiment

Non-null

Create a new experiment

createOneHook

Non-null

createOneIntegration

Non-null

createOnePlan

Non-null

Create a new plan

createOneProduct

Non-null

Create one product mutation

createOrUpdateAwsMarketplaceProduct

Non-null

Create or update an AWS Marketplace product

createPackageGroup

Non-null

Creating a package group

createPlanDraft

Non-null

Create a plan draft

createSubscription

Non-null

createUsageMeasurement

Non-null

Create usage measurement

createWorkflowTrigger

Non-null

Create a new workflow trigger

delegateSubscriptionToCustomer

Non-null

Delegates a subscription to a different customer (the paying customer of the subscription will not change)

deleteFeature

Non-null

Permanently delete a feature

deleteOneFeature

Non-null

Permanently delete a feature (deprecated)

deleteOneHook

Non-null

deleteOneIntegration

Non-null

deleteOnePackageEntitlement

Non-null

deleteOnePrice

Non-null

deleteOneProduct

Non-null

Delete one product mutation

deleteOnePromotionalEntitlement

Non-null

deleteWorkflowTrigger

Delete a workflow trigger

detachCustomerPaymentMethod

Non-null

Detach a payment method from a customer

duplicateProduct

Non-null

Duplicate product mutation

editPackageGroup

Non-null

Editing a package group

estimateSubscription

Non-null

estimateSubscriptionUpdate

Non-null

grantPromotionalEntitlements

Non-null

Grant multiple promotional entitlements

hideGettingStartedPage

Non-null

Hide the getting started page for the member

importCustomersBulk

Import customers in bulk

importOneCustomer

Non-null

Import a customer

importSubscriptionsBulk

initAddStripeCustomerPaymentMethod

Non-null

Initialize a payment method form for a customer

inviteMembers

Non-null

Invite members to the account

markInvoiceAsPaid

Triggers mark invoice as paid for the given subscription

mergeEnvironment

Non-null

Merge data from an existing environment to another environment or to a new environment

migrateSubscriptionToLatest

Non-null

preparePaymentMethodForm

Non-null

Get context to render a payment method form

previewNextInvoice

Non-null

previewSubscription

Non-null

provisionCustomer

Non-null

Provision a customer and subscription

provisionSandbox

Non-null

Provision a sandbox environment

provisionSubscription

Non-null

provisionSubscriptionV2

Non-null

publishAddon

Non-null

Publish an addon by id

publishPlan

Non-null

Publish a plan

purgeCustomerCache

Non-null

recalculateEntitlements

Non-null

registerMember

Non-null

Register a new member with the provided email and roles

removeAddonDraft

Non-null

Remove a draft addon

removeBasePlanFromPlan

Non-null

removeCompatibleAddonsFromPlan

Non-null

removeCouponFromCustomer

Non-null

removeExperimentFromCustomer

Non-null

removeExperimentFromCustomerSubscription

Non-null

removeMember

Non-null

Remove a member from the account

removePlanDraft

Non-null

Remove a plan draft

reportEntitlementCheckRequested

Non-null

reportEvent

Report event

reportUsage

Non-null

Report usage

reportUsageBulk

Non-null

Report usage in bulk

resendEmailVerification

Non-null

Resend email verification

resyncIntegration

Non-null

Resync an integration

revokePromotionalEntitlement

Non-null

Revoke a promotional entitlement

setAccessRoles

Set access roles for a member

setBasePlanOnPlan

Non-null

setCompatibleAddonsOnPlan

Non-null

setCompatiblePackageGroups

Non-null

Set compatible package groups for a plan

setCouponOnCustomer

Non-null

setExperimentOnCustomer

Non-null

setExperimentOnCustomerSubscription

Non-null

setPackageGroupAddons

Non-null

Setting the addons of a package group

setPackagePricing

Non-null

Set package pricing

setWidgetConfiguration

startExperiment

Non-null

Start a draft experiment

stopExperiment

Non-null

Stop a running experiment

subscriptionMaximumSpend

syncTaxRates

transferSubscription

Non-null

transferSubscriptionToResource

Non-null

Transfers a subscription to a different resource

triggerImportCatalog

Non-null

Trigger import of catalog data from an integration

triggerImportCustomers

Non-null

Trigger import of customer data from an integration

triggerPlanSubscriptionMigration

Non-null

Trigger plan subscription migration

triggerRBACSync

Non-null

Trigger synchronization of RBAC permissions of the account

triggerSubscriptionBillingMonthEndsSoonWebhook

Non-null

Triggers the subscription billing month ends soon webhook for the given subscription

triggerSubscriptionUsageSync

Non-null

Triggers the subscription usage sync for the given subscription

triggerWorkflow

Non-null

Trigger a workflow

unarchiveAddon

Non-null

Un-archive an addon by id

unarchiveCustomer

Non-null

Unarchive a customer

unarchiveEnvironment

Non-null

Unarchive an environment

unarchiveFeature

Non-null

Unarchive a feature

unarchivePlan

Non-null

Unarchive a plan

updateAccount

Non-null

Update account details

updateEntitlementsOrder

Non-null

Update entitlements order

updateFeature

Non-null

Update a feature

updateOneAddon

Non-null

Update an addon by id

updateOneCoupon

Non-null

updateOneCustomer

Non-null

Update a customer

updateOneEnvironment

Non-null

updateOneExperiment

Non-null

Update an existing experiment

updateOneHook

Non-null

updateOneIntegration

Non-null

updateOnePackageEntitlement

Non-null

updateOnePlan

Non-null

Update an existing plan

updateOneProduct

Non-null

updateOnePromotionalEntitlement

Non-null

updateOneSubscription

Non-null

updateUser

Non-null

Updates the user information

workflowsLogin

Non-null

Authentication for the workflows UI