arc

Public API

A read-only API for plans, subscriptions, customers and analytics, authenticated with a per-store key. Limited to 120 requests every 60 seconds.

AvailableShown for the least mature part of this page.

Request early accessHow it works

DevelopersRead-only key

GET /api/v1/subscriptions
Authorization: Bearer <your key>
  • Plans
  • Subscriptions
  • Customers
  • Analytics

Public API

What it does

  • Every endpoint answers only for the store that owns the key. A key from one store cannot read another store's plans, subscriptions, customers or analytics.

  • Subscription and customer lists can be sorted and filtered, and an unknown filter or sort value returns an error instead of being ignored.

Step by step

How it works

  1. Create a key

    Merchants create keys in the admin. A key is shown once when it is created, only its hash is stored, and a revoked key stops working.

  2. Send requests

    Requests send the key as a bearer token. A missing, unknown or revoked key gets an unauthorized response before any data is read.

  3. Stay within the limit

    A key that goes over its rate limit gets a too-many-requests response with a Retry-After header.

What it does not do yet

Limits are listed plainly so you can judge fit before you start.

  • The API is read-only. There are no endpoints to create, change or cancel a subscription.

  • A key can read every endpoint for its store, and each store can have only a limited number of active keys.

Try it with your own subscribers.

Request early access and tell us about your store. Arc is not listed in the Shopify App Store yet.

Request early access