Developer Docs

Query

The Firmhouse GraphQL API query RootQuery. All your queries should start with the top-level objects defined in this query.

Fields

currentCart (Cart)
Returns current cart calculations object identified by X-Subscription-Token.
discountCodes (DiscountCodeConnection)
List of discount codes.
ArgumentDescription
after (String)
Returns the elements in the list that come after the specified cursor.
before (String)
Returns the elements in the list that come before the specified cursor.
first (Int)
Returns the first _n_ elements from the list.
last (Int)
Returns the last _n_ elements from the list.
getCurrentProject (Project)
Returns the project identified by current access token.
getDiscountCode (DiscountCode)
Get discount code details. Fetch by code is case-insensitive.
getInvoice (Invoice)
Fetch an invoice by token.
ArgumentDescription
token (ID!)
getOrder (Order)
Fetch an order
ArgumentDescription
id (ID!)
getOrderCalculations (OrderCalculation)
Deprecated: Will be removed.
Calculate order prices
ArgumentDescription
orderedProducts ([OrderedProductInput!])
The ordered products that are part of the order
discountCode (String)
getOrders ([Order!])
Deprecated: Use `orders` connection instead.
List of orders
getPayment (Payment)
Fetch payment by token.
ArgumentDescription
token (ID!)
getSubscription (Subscription)
Get subscription details.
ArgumentDescription
token (ID!)
getSubscriptionBySelfServiceCenterLoginToken (Subscription!)
Fetch subscription by self service center login token.
ArgumentDescription
token (ID!)
getSubscriptions ([Subscription!])
Deprecated: Use the `subscriptions` connection instead.
Returns paginated list of all subscriptions
ArgumentDescription
limit (Int)
offset (Int)
updatedSince (Int)
List of orders
ArgumentDescription
after (String)
Returns the elements in the list that come after the specified cursor.
before (String)
Returns the elements in the list that come before the specified cursor.
first (Int)
Returns the first _n_ elements from the list.
last (Int)
Returns the last _n_ elements from the list.
List of plans.
ArgumentDescription
after (String)
Returns the elements in the list that come after the specified cursor.
before (String)
Returns the elements in the list that come before the specified cursor.
first (Int)
Returns the first _n_ elements from the list.
last (Int)
Returns the last _n_ elements from the list.
List of products.
ArgumentDescription
sku (String)
Only list products that match the passed in SKU
after (String)
Returns the elements in the list that come after the specified cursor.
before (String)
Returns the elements in the list that come before the specified cursor.
first (Int)
Returns the first _n_ elements from the list.
last (Int)
Returns the last _n_ elements from the list.
subscriptions (SubscriptionConnection)
List of subscriptions
ArgumentDescription
after (String)
Returns the elements in the list that come after the specified cursor.
before (String)
Returns the elements in the list that come before the specified cursor.
first (Int)
Returns the first _n_ elements from the list.
last (Int)
Returns the last _n_ elements from the list.