> ## Documentation Index
> Fetch the complete documentation index at: https://subscriptions-docs.getappfox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Overview

> Server-to-server API for finding and managing subscription contracts

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 in the **Enterprise** plan. API requests are disabled on lower tiers. Existing keys are retained when you downgrade but won't authenticate until you restore the Enterprise plan.

## Base URL

All API requests use this base URL:

```
https://subscriptions-app-new.getappfox.com
```

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 cannot sell selling plans, so staff cannot enroll a customer into a subscription at the register through a native POS UI. Your custom POS extension can **find and manage** existing contracts through this API (search, pause, resume, cancel). New enrollments still happen online or in the Shopify admin.

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](mailto:support@getappfox.com).

## Next steps

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/api/authentication">
    Generate API keys and authenticate your requests
  </Card>

  <Card title="Manage contracts" icon="arrows-rotate" href="/api/contracts">
    Find, inspect, pause, resume, and cancel subscriptions
  </Card>
</CardGroup>