Mutation

Activates an inactive subscription.

Applies a promotion to a subscription.

Assign asset to a subscription.

Cancels an 'in progress' return order.

Cancels a subscription or initiates cancellation when two-step cancellation is enabled on your project.

Completes an 'in progress' return order.

Completes the subscription cancellation process (only available when two-step cancellation is enabled on your project).

Creates an asset for a product, optionally assigns it to a subscription.

Creates an empty draft/cart subscription.

Creates a discount code

Creates an invoice line item for an invoice.

Immediately charges and invoices the given amount. If initiating the charge succeeds, an invoice is also created. When initiating the charge fails, no invoice is created. It's possible that the payment and invoice status are open or pending until a final succesful payment status is received from your Payment Service Provider. This could take a couple of business days for certain payment methods, like SEPA direct debit.

Creates an ordered product on subscription identified via `X-Subscription-Token` or `X-Project-Access-Token`.

Creates a product.

Creates a promotion.

Creates a return order for the subscription.

Creates a SelfServiceCenterLoginToken and sends an email to the customer's email address on file so they can log into their self service center.

Creates and returns a SelfServiceCenterLoginToken.

Creates a service channel.

Creates a new subscription and returns payment redirection URLs.

Finalises a subscription and returns payment details based on a cart/draft subscription identified by `X-Subscription-Token`.

Immediately creates a credit invoice and a tries to create a refund for the full amount of the original invoice. If initiating the refund fails, a refundError will be returned but the credit invoice would be created nevertheless. It's possible that the refund status are open or pending until a final succesful payment status is received from your Payment Service Provider. This could take a couple of business days for certain payment methods, like SEPA direct debit.

Deactivates an applied promotion.

Destroys an invoice line item.

Deletes an ordered product from the subscription identified via `X-Subscription-Token` or when authenticated through a project write token.

Edits a plan.

Marks an order as fulfilled. If Track&Trace code is given in will also trigger Track&Trace email.

Option to mark multiple orders as fulfilled at once, up to a maximum of 100 orders each time.

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.

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.

Issues a refund for a payment. Some payment service providers may limit the maximum amount for or timeframe in which you can refund a payment.

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**.

Creates a SelfServiceCenterLoginToken and sends an email to the customer's email address on file so they can log into their self service center.

Immediately creates an order for the passed ordered products of the subscription. Any other ordered products of this subscription scheduled for today will also be shipped in the same order.

Initiates a plan switch offer for subscription.

Syncs products from Shopify to Firmhouse.

Unassign asset from a subscription, this will mark the asset ownership as returned.

Stops the subscription cancellation process (only available when two-step cancellation is enabled on your project).

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.

Updates a promotion applied to a Subscription

Update an asset.

Updates an asset ownership.

Updates an invoice.

Updates an invoice line item.

Updates Order attributes. Only status, fulfilledAt timestamp, and trackingCode are allowed to be updated. Fulfillment process will not be triggered.

Updates the ordered product on a subscription identified via `X-Subscription-Token`.

Updates an ordered product's quantity identified via `X-Subscription-Token`.

Updates the active plan of the subscription identified via `X-Subscription-Token`.

Updates a product.

Updates a promotion.

Updates an 'in progress' return order.

Updates the shipping costs exemption.

Updates the subscribed plan.

Updates a subscription.