Quickstart

​

Prerequisites

• An active Appfox Subscriptions installation
• The Enterprise plan (external API access is Enterprise-only)
• At least one active subscription contract in your shop

​

Step 1: Generate an API key

1. Open the Appfox Subscriptions app in your Shopify admin
2. Click API in the sidebar
3. Click Generate key
4. Copy the key that starts with afx_live_ — you’ll only see it once

​

Step 2: Get a contract ID

• The Appfox app under Subscriptions (the numeric ID in the URL or table)
• Your Shopify admin under Orders → Subscriptions
• Shopify’s Admin GraphQL API

​

Step 3: Pause a subscription

curl https://subscriptions-app-new.getappfox.com/api/v1/subscription-contracts/123456789/actions \
  -X POST \
  -H "Authorization: Bearer afx_live_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "pause",
    "resumeAt": "2026-10-01T09:00:00Z"
  }'

• afx_live_YOUR_KEY_HERE with your actual API key
• 123456789 with a real contract ID
• 2026-10-01T09:00:00Z with a future date (up to 60 days from now)

​

Expected response

{
  "data": {
    "id": "gid://shopify/SubscriptionContract/123456789",
    "status": "PAUSED",
    "scheduledResumeAt": "2026-10-01T09:00:00.000Z"
  }
}

​

Step 4: Resume immediately

curl https://subscriptions-app-new.getappfox.com/api/v1/subscription-contracts/123456789/actions \
  -X POST \
  -H "Authorization: Bearer afx_live_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{"action": "resume"}'

​

Expected response

{
  "data": {
    "id": "gid://shopify/SubscriptionContract/123456789",
    "status": "ACTIVE",
    "scheduledResumeAt": null
  }
}

​

Common issues

• A valid ISO-8601 timestamp
• In the future
• No more than 60 days from now

​

Next steps