The Firmhouse Logo [FH]
Developer Docs

Mutation

The Firmhouse GraphQL API mutations root object.

Fields

activateSubscription (ActivateSubscriptionPayload)
Activates an inactive subscription.
ArgumentDescription
input (ActivateSubscriptionInput!)
Parameters for ActivateSubscription
applyPromotionToSubscription (ApplyPromotionToSubscriptionPayload)
Applies a promotion to a subscription.
ArgumentDescription
input (ApplyPromotionToSubscriptionInput!)
Parameters for ApplyPromotionToSubscription
cancelSubscription (CancelSubscriptionPayload)
Cancels a subscription or initiates cancellation when two-step cancellation is enabled on your project.
ArgumentDescription
input (CancelSubscriptionInput!)
Parameters for CancelSubscription
completeSubscriptionCancellation (CompleteSubscriptionCancellationPayload)
Completes the subscription cancellation process (only available when two-step cancellation is enabled on your project).
ArgumentDescription
input (CompleteSubscriptionCancellationInput!)
Parameters for CompleteSubscriptionCancellation
createAsset (CreateAssetPayload)
Creates an asset for a product, optionally assigns it to a subscription.
ArgumentDescription
input (CreateAssetInput!)
Parameters for CreateAsset
createCart (CreateCartPayload)
Creates an empty draft/cart subscription.
ArgumentDescription
input (CreateCartInput!)
Parameters for CreateCart
createDiscountCode (CreateDiscountCodePayload)
Creates a discount code
ArgumentDescription
input (CreateDiscountCodeInput!)
Parameters for CreateDiscountCode
createOrder (CreateOrderPayload)
Deprecated: The behavior of this mutation will be changed significantly soon.
ArgumentDescription
input (CreateOrderInput!)
Parameters for CreateOrder
createOrderedProduct (CreateOrderedProductPayload)
Creates an ordered product on subscription identified via `X-Subscription-Token` or `X-Project-Access-Token`.
ArgumentDescription
input (CreateOrderedProductInput!)
Parameters for CreateOrderedProduct
createProduct (CreateProductPayload)
Creates a product.
ArgumentDescription
input (CreateProductInput!)
Parameters for CreateProduct
createPromotion (CreatePromotionPayload)
Creates a promotion.
ArgumentDescription
input (CreatePromotionInput!)
Parameters for CreatePromotion
createSelfServiceCenterLoginToken (CreateSelfServiceCenterLoginTokenPayload)
Creates a SelfServiceCenterLoginToken and sends an email to the customer's email address on file so they can log into their self service center.
ArgumentDescription
input (CreateSelfServiceCenterLoginTokenInput!)
Parameters for CreateSelfServiceCenterLoginToken
createSubscription (CreateSubscriptionPayload)
Creates a new subscription and returns payment redirection URLs.
ArgumentDescription
input (CreateSubscriptionInput!)
Parameters for CreateSubscription
createSubscriptionFromCart (CreateSubscriptionFromCartPayload)
Finalises a subscription and returns payment details based on a cart/draft subscription identified by `X-Subscription-Token`.
ArgumentDescription
input (CreateSubscriptionFromCartInput!)
Parameters for CreateSubscriptionFromCart
deactivateAppliedPromotion (DeactivateAppliedPromotionPayload)
Deactivates an applied promotion.
ArgumentDescription
input (DeactivateAppliedPromotionInput!)
Parameters for DeactivateAppliedPromotion
destroyOrderedProduct (DestroyOrderedProductPayload)
Deletes an ordered product from the subscription identified via `X-Subscription-Token` or when authenticated through a project write token.
ArgumentDescription
input (DestroyOrderedProductInput!)
Parameters for DestroyOrderedProduct
editPlan (EditPlanPayload)
Edits a plan.
ArgumentDescription
input (EditPlanInput!)
Parameters for EditPlan
fulfillOrder (FulfillOrderPayload)
Marks an order as fulfilled. If Track&Trace code is given in will also trigger Track&Trace email.
ArgumentDescription
input (FulfillOrderInput!)
Parameters for FulfillOrder
fulfillOrders (FulfillOrdersPayload)
Option to mark multiple orders as fulfilled at once, up to a maximum of 100 orders each time.
ArgumentDescription
input (FulfillOrdersInput!)
Parameters for FulfillOrders
importSubscription (ImportSubscriptionPayload)
Creates a subscription directly into the database without the need for a customer to signup, only use this when you're migrating from another platform.
ArgumentDescription
input (ImportSubscriptionInput!)
Parameters for ImportSubscription
pauseSubscription (PauseSubscriptionPayload)
Pauses a subscription. You can optionally pass in a time at which the subscription will be resumed. All automatic charging and invoice generation and order generation is put on hold for a paused subscription. Maximum contract terms automatically shift forward on each billing cycle.
ArgumentDescription
input (PauseSubscriptionInput!)
Parameters for PauseSubscription
resumeSubscription (ResumeSubscriptionPayload)
Resumes the subscription. If you do not pass a date or time the resumeFrom argument, then the subscription will be immediately resumed. Resuming a subscription will always change its status to **activated**.
ArgumentDescription
input (ResumeSubscriptionInput!)
Parameters for ResumeSubscription
undoSubscriptionCancellation (UndoSubscriptionCancellationPayload)
Stops the subscription cancellation process (only available when two-step cancellation is enabled on your project).
ArgumentDescription
input (UndoSubscriptionCancellationInput!)
Parameters for UndoSubscriptionCancellation
updateAddressDetails (UpdateAddressDetailsPayload)
Updates certain information on the subscription identified via `X-Subscription-Token`. Will save changes to certain fields even when other fields given are invalid. Will return validation error messages for invalid fields.
ArgumentDescription
input (UpdateAddressDetailsInput!)
Parameters for UpdateAddressDetails
updateAppliedPromotion (UpdateAppliedPromotionPayload)
Updates a promotion applied to a Subscription
ArgumentDescription
input (UpdateAppliedPromotionInput!)
Parameters for UpdateAppliedPromotion
updateAssetOwnership (UpdateAssetOwnershipPayload)
Updates an asset ownership.
ArgumentDescription
input (UpdateAssetOwnershipInput!)
Parameters for UpdateAssetOwnership
updateOrder (UpdateOrderPayload)
Updates Order attributes. Only status, fulfilledAt timestamp, and trackingCode are allowed to be updated. Fulfillment process will not be triggered.
ArgumentDescription
input (UpdateOrderInput!)
Parameters for UpdateOrder
updateOrderedProduct (UpdateOrderedProductPayload)
Updates the ordered product on a subscription identified via `X-Subscription-Token`.
ArgumentDescription
input (UpdateOrderedProductInput!)
Parameters for UpdateOrderedProduct
updateOrderedProductQuantity (UpdateOrderedProductQuantityPayload)
Updates an ordered product's quantity identified via `X-Subscription-Token`.
ArgumentDescription
input (UpdateOrderedProductQuantityInput!)
Parameters for UpdateOrderedProductQuantity
updatePlan (UpdatePlanPayload)
Updates the active plan of the subscription identified via `X-Subscription-Token`.
ArgumentDescription
input (UpdatePlanInput!)
Parameters for UpdatePlan
updateProduct (UpdateProductPayload)
Updates a product.
ArgumentDescription
input (UpdateProductInput!)
Parameters for UpdateProduct
updatePromotion (UpdatePromotionPayload)
Updates a promotion.
ArgumentDescription
input (UpdatePromotionInput!)
Parameters for UpdatePromotion
updateSubscribedPlan (UpdateSubscribedPlanPayload)
Updates the subscribed plan.
ArgumentDescription
input (UpdateSubscribedPlanInput!)
Parameters for UpdateSubscribedPlan
updateSubscription (UpdateSubscriptionPayload)
Updates a subscription.
ArgumentDescription
input (UpdateSubscriptionInput!)
Parameters for UpdateSubscription