Developer Docs

Mutation

The Firmhouse GraphQL API mutations root object.

Fields

cancelSubscription (CancelSubscriptionPayload)
Cancels a subscription or initiates cancellation when two-step cancellation is enabled on your project.
ArgumentDescription
input (CancelSubscriptionInput!)
createCart (CreateCartPayload)
Creates an empty draft/cart subscription.
ArgumentDescription
input (CreateCartInput!)
createOrder (CreateOrderPayload)
Deprecated: The behavior of this mutation will be changed significantly soon.
ArgumentDescription
input (CreateOrderInput!)
createOrderedProduct (CreateOrderedProductPayload)
Creates an ordered product on subscription identified via `X-Subscription-Token`.
ArgumentDescription
input (CreateOrderedProductInput!)
createProduct (CreateProductPayload)
Creates a product.
ArgumentDescription
input (CreateProductInput!)
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!)
createSubscription (CreateSubscriptionPayload)
Creates a new subscription and returns payment redirection URLs.
ArgumentDescription
input (CreateSubscriptionInput!)
createSubscriptionFromCart (CreateSubscriptionFromCartPayload)
Finalises a subscription and returns payment details based on a cart/draft subscription identified by `X-Subscription-Token`.
ArgumentDescription
input (CreateSubscriptionFromCartInput!)
destroyOrderedProduct (DestroyOrderedProductPayload)
Deletes an ordered product from the subscription identified via `X-Subscription-Token`.
ArgumentDescription
input (DestroyOrderedProductInput!)
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!)
updateOrderedProduct (UpdateOrderedProductPayload)
Updates the ordered product on a subscription identified via `X-Subscription-Token`.
ArgumentDescription
input (UpdateOrderedProductInput!)
updateOrderedProductQuantity (UpdateOrderedProductQuantityPayload)
Updates an ordered product's quantity identified via `X-Subscription-Token`.
ArgumentDescription
input (UpdateOrderedProductQuantityInput!)
updatePlan (UpdatePlanPayload)
Updates the active plan of the subscription identified via `X-Subscription-Token`.
ArgumentDescription
input (UpdatePlanInput!)
updateProduct (UpdateProductPayload)
Updates a product.
ArgumentDescription
input (UpdateProductInput!)
updateSubscription (UpdateSubscriptionPayload)
Updates a subscription.
ArgumentDescription
input (UpdateSubscriptionInput!)