Skip to main content

Zubs APIs

Zubs has two GraphQL APIs that let you show and manage subscriptions outside the Zubs merchant portal. Both are included in your plan, and we set them up on request.

Admin APICustomer API
ForYour own servers: back office, helpdesk, reporting, automated processesApps your customers use, such as your own mobile app
Who is signed inYour store, with a private Admin API keyOne customer, with their Shopify customer account
What it reachesEvery subscription in your storeThat customer's own subscriptions
Endpointhttps://hub.zubs.app/api/admin/unstable/graphql.jsonhttps://hub.zubs.app/api/storefront/unstable/graphql.json
GuideAdmin APICustomer API

What the APIs Cover​

Both APIs can read and change subscriptions. You can read:

  • subscriptions, with their products, prices, delivery method and delivery interval
  • upcoming and past billing cycles, and payment retries
  • the subscription timeline, pause details, available delivery intervals, shipping options and pickup locations
  • your cancellation reasons

You can take these actions:

  • skip or unskip a billing cycle
  • reschedule the next billing date
  • ship an order now
  • pause, resume or cancel a subscription
  • update the customer's address
  • send the customer an email to update their payment method

You can also change what's in a subscription: add, remove or swap products, change quantities, the delivery interval, the delivery method or pickup location, apply discounts, and edit a single upcoming order. These operations aren't in the API explorer yet. Tell us what you want to change and we send you the operations you need.

Letting customers manage their subscriptions: show the subscription data natively in your app, and take the actions listed above through the API. For changes to products, quantities, delivery interval and the like, add a Manage subscription button that opens the customer portal. It's part of the customer's Shopify account, so they don't need to sign in again. The portal already handles your stock and pricing, and changes we make to it reach your customers without any work on your side.

Server-to-server and automated processes: use the Admin API to change subscription content directly, for example to swap a discontinued product across subscriptions, apply a discount from your helpdesk, or adjust upcoming orders from your own system.

API Reference​

The API explorer lists every documented operation with its arguments and types. Download the schema as an SDL file for code generation and autocompletion. The reference applies to both APIs.

Subscriptions created with Zubs are Shopify subscription contracts. Shopify's own Admin API and other apps still see them.

Request Access​

Email support@zubs.app with:

  • your store's .myshopify.com domain
  • which API you need, and what you want to build
  • for the Customer API: your Client ID (see Generate a Client ID)

We can also set up access for a development store, so you can build and test before going live.

Versioning and Changes​

Both APIs have one version, unstable, which is part of the endpoint URL. We add fields and operations over time. If we change or remove something your integration may rely on, we tell you in advance.

Request only the fields you use, and ignore fields and enum values you don't recognize.