Overview
The Subi API allows developers and technical teams to manage contracts and subscriptions programmatically. This is ideal for integrating Subi with internal systems, external tools, data warehouses, or custom applications.
With the API, you can automate subscription workflows and keep contract data in sync across platforms.
What your store needs
The Subi API is included in every current paid Subi plan and in almost every older one, so most stores do not need an add-on to use it.
To check, open Settings > API keys in Subi. On a paid plan you can generate a key right away. On the Free plan the page shows a lock and an Upgrade your plan button, which lists the plans that include the API. If your store is on an older plan and the page still shows a lock, click Upgrade your plan: it offers a current plan that includes it, or the API, webhook & MCP access add-on.
The MCP server is the one part that is not in every plan. It comes with the Subi Plus plan and some older plans, or with the MCP add-on, listed at $49 per month. On current paid plans the Add ons page names it MCP server access, since the API and webhooks are already included; on older plans it is named API, webhook & MCP access.
What You Can Do with the Subi API
Using the Subi API, you can:
Read your subscribers and their details
Read subscription contracts, one at a time or as a paginated list
Cancel, pause, resume, skip or reschedule a subscription contract
Update the lines on a contract: swap a variant, change a quantity or a line discount, add a line, remove a line
Keep your own systems in step with your subscription data
The API works on subscriptions that already exist. It does not create a subscription and it does not delete one. A subscription starts when a customer checks out with a subscription plan, or when you create it for them in the Subi admin, and it ends when it is cancelled or when it reaches the end of its cycles. A contract you read from the API can be ACTIVE, PAUSED, FAILED, CANCELLED, EXPIRED or DEACTIVATED, so handle all six.
Who it's for: This feature is intended for developers and technical users who want full programmatic control over contract and subscription data.
How to Generate an API Key
To access the Subi API, you’ll need to generate an API key from your Subi dashboard.
Steps to generate your API key:
Log in to your Subi dashboard.
Go to Settings.
Click on API keys.
Select Generate API key.
Copy and securely store your API key.
⚠️ Important: Keep your API key confidential. Do not share it publicly or expose it in any client-side code.
API Key Management Screen
This image shows the API Keys section in the Subi dashboard, where you can generate and manage keys to connect with external systems.
Authenticating API Requests
Every request carries your key in the X-Api-Key header.
Standard endpoints allow 60 requests per minute. Past that the API answers 429 Too Many Requests. List endpoints are paginated with limit (15 by default, 100 at most) and offset, and each response carries the total count with the next and previous pages.
The Subi API Documentation has every endpoint with example requests and responses.
Where to Find Full API Documentation
For technical specifications, available endpoints, example requests/responses, and authentication details, visit the official API docs:
Need Help?
If you need assistance with the API or have questions about your integration, contact the Subi support team or explore other developer articles in our Help Center.