Skip to main content
The Appfox Subscriptions API lets your backend systems find, inspect, pause, resume, and cancel subscription contracts that were created through Appfox. Since Shopify only allows the owning subscription app to manage contracts, integrations call Appfox rather than Shopify directly.

​
Who can use this API

External API access is included for every store while Appfox Subscriptions is free for now. Generate a key from the API screen in the app.

​
Base URL

All API requests use this base URL:
Use the /api/v1/subscription-contracts routes documented here. Do not call /api/external/contracts.

​
What you can do

The API supports subscription contract lookup and lifecycle management:
  • Find subscriptions — GET /api/v1/subscription-contracts by customer ID, email, contract ID, and status
  • Inspect a subscription — GET /api/v1/subscription-contracts/{contractId} reads current details from Shopify
  • Pause a subscription — POST .../actions with action: pause. resumeAt is required and must be within 60 days
  • Resume a subscription — Immediately reactivate a paused contract
  • Cancel a subscription — Permanently cancel a contract

​
POS and enrollment

Shopify POS can enroll customers in subscription selling plans directly at the register using the Appfox Subscriptions smart grid tile (requires POS 10.15+ and Shopify Payments). Staff add products to the cart, tap the Subscriptions tile, and select an available plan. The subscription contract is created when the customer completes checkout with Shopify Payments. Your custom POS backend can also use this API to find and manage existing contracts (search, pause, resume, cancel) through server-to-server calls. New enrollments through custom POS apps still require the native Shopify POS tile or online storefront enrollment. Keep the API key on your backend. POS UI extensions must not hold afx_live_ keys.

​
Rate limits

API requests are not currently rate-limited per key, but abusive usage may be throttled at the infrastructure level.

​
Support

If you have questions or need help integrating, email support@getappfox.com.

​
MCP Server for IDEs

If you’re a developer using Cursor, Claude Code, or VS Code, you can also connect to subscription data through Model Context Protocol (MCP). The MCP server lets your AI assistant query subscriptions in natural language and get live results. It uses the same API keys as the REST API.

​
Next steps

Authentication

Generate API keys and authenticate your requests

Manage contracts

Find, inspect, pause, resume, and cancel subscriptions

MCP Server

Connect IDEs to subscription data with MCP