Magidoc

Mutation
Object

Fields

#

addCompatibleAddonsToPlan

Plan !
Non-null

applySubscription

ApplySubscription !
Non-null

archiveAddon

Addon !
Non-null

Archive an addon by id

archiveCustomer

Customer !
Non-null

archiveEnvironment

Environment !
Non-null

archiveFeature

Feature !
Non-null

archiveOneCoupon

Coupon !
Non-null

archivePackageGroup

PackageGroup !
Non-null

archivePlan

Plan !
Non-null

attachCustomerPaymentMethod

Customer !
Non-null

cancelSchedule

String !
Non-null

cancelSubscription

CustomerSubscription !
Non-null

chargeSubscriptionUsage

ChargeSubscriptionUsage !
Non-null

Immediately charges usage in the given subscription

createAccount

Member !
Non-null

createAddonDraft

Addon !
Non-null

createEmptyAddonDraft

Addon !
Non-null

createEmptyPlanDraft

Plan !
Non-null

createFeature

Feature !
Non-null

createManyPackageEntitlements

[ PackageEntitlement !]!
Non-null

createManyPromotionalEntitlements

[ PromotionalEntitlement !]!
Non-null

createOneAddon

Addon !
Non-null

createOneCoupon

Coupon !
Non-null

createOneCustomer

Customer !
Non-null

createOneEnvironment

Environment !
Non-null

createOneExperiment

Experiment !
Non-null

createOneHook

Hook !
Non-null

createOneIntegration

Integration !
Non-null

createOnePlan

Plan !
Non-null

createOneProduct

Product !
Non-null

createOrUpdateAwsMarketplaceProduct

Product !
Non-null

createPackageGroup

PackageGroup !
Non-null

createPlanDraft

Plan !
Non-null

createSubscription

CustomerSubscription !
Non-null

createUsageMeasurement

UsageMeasurementWithCurrentUsage !
Non-null

createWorkflowTrigger

WorkflowTriggerDTO !
Non-null

Create a new workflow trigger

delegateSubscriptionToCustomer

CustomerSubscription !
Non-null

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

deleteFeature

Feature !
Non-null

deleteOneFeature

Feature !
Non-null

deleteOneHook

HookDeleteResponse !
Non-null

deleteOneIntegration

IntegrationDeleteResponse !
Non-null

deleteOnePackageEntitlement

PackageEntitlementDeleteResponse !
Non-null

deleteOnePrice

PriceDeleteResponse !
Non-null

deleteOneProduct

ProductDeleteResponse !
Non-null

deleteOnePromotionalEntitlement

PromotionalEntitlementDeleteResponse !
Non-null

deleteWorkflowTrigger

String

Delete a workflow trigger

detachCustomerPaymentMethod

Customer !
Non-null

duplicateProduct

Product !
Non-null

editPackageGroup

PackageGroup !
Non-null

estimateSubscription

SubscriptionPreview !
Non-null

estimateSubscriptionUpdate

SubscriptionPreview !
Non-null

grantPromotionalEntitlements

[ PromotionalEntitlement !]!
Non-null

hideGettingStartedPage

String !
Non-null

importCustomersBulk

String

importOneCustomer

Customer !
Non-null

importSubscriptionsBulk

String

initAddStripeCustomerPaymentMethod

InitAddStripeCustomerPaymentMethod !
Non-null

inviteMembers

MembersInviteResponse !
Non-null

markInvoiceAsPaid

String

Triggers mark invoice as paid for the given subscription

mergeEnvironment

MergeEnvironment !
Non-null

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

migrateSubscriptionToLatest

CustomerSubscription !
Non-null

preparePaymentMethodForm

PreparedPaymentMethodForm !
Non-null

previewNextInvoice

SubscriptionInvoicePreview !
Non-null

previewSubscription

SubscriptionPreviewV2 !
Non-null

provisionCustomer

ProvisionedCustomer !
Non-null

provisionSandbox

Environment !
Non-null

provisionSubscription

ProvisionSubscriptionResult !
Non-null

provisionSubscriptionV2

ProvisionSubscriptionResult !
Non-null

publishAddon

PublishPackageResult !
Non-null

publishPlan

PublishPackageResult !
Non-null

purgeCustomerCache

String !
Non-null

recalculateEntitlements

RecalculateEntitlementsResult !
Non-null

registerMember

User !
Non-null

removeAddonDraft

String !
Non-null

removeBasePlanFromPlan

Plan !
Non-null

removeCompatibleAddonsFromPlan

Plan !
Non-null

removeCouponFromCustomer

Customer !
Non-null

removeExperimentFromCustomer

Customer !
Non-null

removeExperimentFromCustomerSubscription

CustomerSubscription !
Non-null

removeMember

String !
Non-null

removePlanDraft

String !
Non-null

reportEntitlementCheckRequested

Boolean !
Non-null

reportEvent

String

reportUsage

UsageMeasurementWithCurrentUsage !
Non-null

reportUsageBulk

[ UsageMeasurementWithCurrentUsage !]!
Non-null

resendEmailVerification

String !
Non-null

resyncIntegration

ResyncIntegrationResult !
Non-null

revokePromotionalEntitlement

PromotionalEntitlement !
Non-null

setAccessRoles

String

setBasePlanOnPlan

Plan !
Non-null

setCompatibleAddonsOnPlan

Plan !
Non-null

setCompatiblePackageGroups

Plan !
Non-null

Set compatible package groups for a plan

setCouponOnCustomer

Customer !
Non-null

setExperimentOnCustomer

Customer !
Non-null

setExperimentOnCustomerSubscription

CustomerSubscription !
Non-null

setPackageGroupAddons

PackageGroup !
Non-null

setPackagePricing

PackagePrice !
Non-null

setWidgetConfiguration

String

startExperiment

String !
Non-null

stopExperiment

String !
Non-null

subscriptionMaximumSpend

SubscriptionMaximumSpend

syncTaxRates

String

transferSubscription

CustomerSubscription !
Non-null

transferSubscriptionToResource

CustomerSubscription !
Non-null

Transfers a subscription to a different resource

triggerImportCatalog

AsyncTaskResult !
Non-null

triggerImportCustomers

AsyncTaskResult !
Non-null

triggerPlanSubscriptionMigration

TriggerSubscriptionMigrationResult !
Non-null

triggerRBACSync

String !
Non-null

triggerSubscriptionBillingMonthEndsSoonWebhook

String !
Non-null

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

triggerSubscriptionUsageSync

Boolean !
Non-null

Triggers the subscription usage sync for the given subscription

triggerWorkflow

TriggerWorkflowDTO !
Non-null

Trigger a workflow

unarchiveAddon

Addon !
Non-null

Un-archive an addon by id

unarchiveCustomer

Customer !
Non-null

unarchiveEnvironment

Environment !
Non-null

unarchiveFeature

Feature !
Non-null

Unarchive a feature

unarchivePlan

Plan !
Non-null

Unarchive a plan

updateAccount

Account !
Non-null

updateEntitlementsOrder

[ UpdateEntitlementsOrderDTO !]!
Non-null

updateFeature

Feature !
Non-null

updateOneAddon

Addon !
Non-null

updateOneCoupon

Coupon !
Non-null

updateOneCustomer

Customer !
Non-null

updateOneEnvironment

Environment !
Non-null

updateOneExperiment

Experiment !
Non-null

updateOneHook

Hook !
Non-null

updateOneIntegration

Integration !
Non-null

updateOnePackageEntitlement

PackageEntitlement !
Non-null

updateOnePlan

Plan !
Non-null

updateOneProduct

Product !
Non-null

updateOnePromotionalEntitlement

PromotionalEntitlement !
Non-null

updateOneSubscription

CustomerSubscription !
Non-null

updateUser

User !
Non-null

workflowsLogin

WorkflowsLoginDTO !
Non-null

Authentication for the workflows UI