Magidoc

Mutation
Object

Fields

#

addCompatibleAddonsToPlan

Plan !
Non-null

applySubscription

ApplySubscription !
Non-null

archiveAddon

Addon !
Non-null

Archive an addon by refId

archiveCustomer

Customer !
Non-null

Archive a customer

archiveEnvironment

Environment !
Non-null

Archive an environment

archiveFeature

Feature !
Non-null

Archive a feature

archiveFeatureGroup

FeatureGroup !
Non-null

Archive a feature group

archiveOneCoupon

Coupon !
Non-null

archivePackageGroup

PackageGroup !
Non-null

Archiving a package group

archivePlan

Plan !
Non-null

Archive a plan

attachCustomerPaymentMethod

Customer !
Non-null

Attach a payment method to a customer

cancelSchedule

String !
Non-null

cancelSubscription

CustomerSubscription !
Non-null

chargeSubscriptionUsage

ChargeSubscriptionUsage !
Non-null

Immediately charges usage in the given subscription

createAccount

Member !
Non-null

Create a new account

createAddonDraft

Addon !
Non-null

Create a draft addon from an addon by id

createEmptyAddonDraft

Addon !
Non-null

Create an empty draft addon from an addon by id

createEmptyPlanDraft

Plan !
Non-null

Create an empty plan draft

createFeature

Feature !
Non-null

Create a new feature

createFeatureGroup

FeatureGroup !
Non-null

Create a new version of a feature group

createManyPackageEntitlements

[ PackageEntitlement !]!
Non-null

createManyPromotionalEntitlements

[ PromotionalEntitlement !]!
Non-null

createOneAddon

Addon !
Non-null

Create an addon

createOneCoupon

Coupon !
Non-null

createOneCustomer

Customer !
Non-null

Create a new customer

createOneEnvironment

Environment !
Non-null

Create a new environment

createOneExperiment

Experiment !
Non-null

Create a new experiment

createOneHook

Hook !
Non-null

createOneIntegration

Integration !
Non-null

createOnePlan

Plan !
Non-null

Create a new plan

createOneProduct

Product !
Non-null

Create one product mutation

createOrUpdateAwsMarketplaceProduct

Product !
Non-null

Create or update an AWS Marketplace product

createPackageGroup

PackageGroup !
Non-null

Creating a package group

createPlanDraft

Plan !
Non-null

Create a plan draft

createSubscription

CustomerSubscription !
Non-null

createUsageMeasurement

UsageMeasurementWithCurrentUsage !
Non-null

Create usage measurement

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

Permanently delete a feature

deleteOneFeature

Feature !
Non-null

Permanently delete a feature (deprecated)

deleteOneHook

HookDeleteResponse !
Non-null

deleteOneIntegration

IntegrationDeleteResponse !
Non-null

deleteOnePackageEntitlement

PackageEntitlementDeleteResponse !
Non-null

deleteOnePrice

PriceDeleteResponse !
Non-null

deleteOneProduct

ProductDeleteResponse !
Non-null

Delete one product mutation

deleteOnePromotionalEntitlement

PromotionalEntitlementDeleteResponse !
Non-null

deleteWorkflowTrigger

String

Delete a workflow trigger

detachCustomerPaymentMethod

Customer !
Non-null

Detach a payment method from a customer

duplicateProduct

Product !
Non-null

Duplicate product mutation

editPackageGroup

PackageGroup !
Non-null

Editing a package group

estimateSubscription

SubscriptionPreview !
Non-null

estimateSubscriptionUpdate

SubscriptionPreview !
Non-null

grantPromotionalEntitlements

[ PromotionalEntitlement !]!
Non-null

Grant multiple promotional entitlements

hideGettingStartedPage

String !
Non-null

Hide the getting started page for the member

importCustomersBulk

String

Import customers in bulk

importOneCustomer

Customer !
Non-null

Import a customer

importSubscriptionsBulk

String

initAddStripeCustomerPaymentMethod

InitAddStripeCustomerPaymentMethod !
Non-null

Initialize a payment method form for a customer

inviteMembers

MembersInviteResponse !
Non-null

Invite members to the account

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

Get context to render a payment method form

previewNextInvoice

SubscriptionInvoicePreview !
Non-null

previewSubscription

SubscriptionPreviewV2 !
Non-null

provisionCustomer

ProvisionedCustomer !
Non-null

Provision a customer and subscription

provisionSandbox

Environment !
Non-null

Provision a sandbox environment

provisionSubscription

ProvisionSubscriptionResult !
Non-null

provisionSubscriptionV2

ProvisionSubscriptionResult !
Non-null

publishAddon

PublishPackageResult !
Non-null

Publish an addon by id

publishPlan

PublishPackageResult !
Non-null

Publish a plan

purgeCustomerCache

String !
Non-null

Clear the persistent cache for a customer and optionally a resource.

recalculateEntitlements

RecalculateEntitlementsResult !
Non-null

Initiate a recalculation of entitlements for selected customers in an environment.

registerMember

User !
Non-null

Register a new member with the provided email and roles

removeAddonDraft

String !
Non-null

Remove a draft addon

removeBasePlanFromPlan

Plan !
Non-null

removeCompatibleAddonsFromPlan

Plan !
Non-null

removeCouponFromCustomer

Customer !
Non-null

removeExperimentFromCustomer

Customer !
Non-null

removeExperimentFromCustomerSubscription

CustomerSubscription !
Non-null

removeFeatureGroupFromPackage

[ PackageEntitlement !]!
Non-null

Remove feature group from package - remove all entitlements that only belong to this group, and unlink from entitlements that have different groups as well

removeMember

String !
Non-null

Remove a member from the account

removePlanDraft

String !
Non-null

Remove a plan draft

reportEntitlementCheckRequested

Boolean !
Non-null

Log the result of a customer entitlement check for analytics or auditing.

reportEvent

String

Report event

reportUsage

UsageMeasurementWithCurrentUsage !
Non-null

Report usage

reportUsageBulk

[ UsageMeasurementWithCurrentUsage !]!
Non-null

Report usage in bulk

resendEmailVerification

String !
Non-null

Resend email verification

resyncIntegration

ResyncIntegrationResult !
Non-null

Resync an integration

revokePromotionalEntitlement

PromotionalEntitlement !
Non-null

Revoke a promotional entitlement

setAccessRoles

String

Set access roles for a member

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

Setting the addons of a package group

setPackagePricing

PackagePrice !
Non-null

Set package pricing

setWidgetConfiguration

String

Update the widget configuration across different components like checkout, paywall, and customer portal.

startExperiment

String !
Non-null

Start a draft experiment

stopExperiment

String !
Non-null

Stop a running experiment

subscriptionMaximumSpend

SubscriptionMaximumSpend

syncTaxRates

String

Indicates whether to sync tax rates from the billing provider into the specified environment.

transferSubscription

CustomerSubscription !
Non-null

transferSubscriptionToResource

CustomerSubscription !
Non-null

Transfers a subscription to a different resource

triggerImportCatalog

AsyncTaskResult !
Non-null

Trigger import of catalog data from an integration

triggerImportCustomers

AsyncTaskResult !
Non-null

Trigger import of customer data from an integration

triggerPlanSubscriptionMigration

TriggerSubscriptionMigrationResult !
Non-null

Trigger plan subscription migration

triggerRBACSync

String !
Non-null

Trigger synchronization of RBAC permissions of the account

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

Unarchive a customer

unarchiveEnvironment

Environment !
Non-null

Unarchive an environment

unarchiveFeature

Feature !
Non-null

Unarchive a feature

unarchiveFeatureGroup

FeatureGroup !
Non-null

Unarchive a feature group

unarchivePlan

Plan !
Non-null

Unarchive a plan

unlinkFeatureGroupFromPackage

[ PackageEntitlement !]!
Non-null

Unlink feature group from package entitlement - remove group without removing the entitlements

updateAccount

Account !
Non-null

Update account details

updateEntitlementsOrder

[ UpdateEntitlementsOrderDTO !]!
Non-null

Update entitlements order

updateFeature

Feature !
Non-null

Update a feature

updateOneAddon

Addon !
Non-null

Update an addon by id

updateOneCoupon

Coupon !
Non-null

updateOneCustomer

Customer !
Non-null

Update a customer

updateOneEnvironment

Environment !
Non-null

updateOneExperiment

Experiment !
Non-null

Update an existing experiment

updateOneHook

Hook !
Non-null

updateOneIntegration

Integration !
Non-null

updateOnePackageEntitlement

PackageEntitlement !
Non-null

updateOnePlan

Plan !
Non-null

Update an existing plan

updateOneProduct

Product !
Non-null

updateOnePromotionalEntitlement

PromotionalEntitlement !
Non-null

updateOneSubscription

CustomerSubscription !
Non-null

updateUser

User !
Non-null

Updates the user information

workflowsLogin

WorkflowsLoginDTO !
Non-null

Authentication for the workflows UI