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
cancelSubscription (CancelSubscriptionPayload)
Cancels a subscription or initiates cancellation when two-step cancellation is enabled on your project.
ArgumentDescription
input (CancelSubscriptionInput!)
Parameters for CancelSubscription
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
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`.
ArgumentDescription
input (CreateOrderedProductInput!)
Parameters for CreateOrderedProduct
createProduct (CreateProductPayload)
Creates a product.
ArgumentDescription
input (CreateProductInput!)
Parameters for CreateProduct
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
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
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
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
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
updateSubscription (UpdateSubscriptionPayload)
Updates a subscription.
ArgumentDescription
input (UpdateSubscriptionInput!)
Parameters for UpdateSubscription