Authentication

​

Generate an API key

1. Open the Appfox Subscriptions app from your Shopify admin
2. Click Settings, then API
3. Click Generate key
4. Copy the key immediately — it’s only shown once

• Browser bundles or mobile apps
• POS UI extensions
• Source control
• Application logs
• Query parameters or URLs

​

Key management

• Each shop can have up to 5 active keys
• Keys can be revoked immediately from the same API screen
• Only a SHA-256 digest is stored by Appfox
• Keys are permanently scoped to the shop that created them

​

Making authenticated requests

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

​

Server-to-server only

​

Error responses

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or revoked API key."
  }
}

{
  "error": {
    "code": "plan_required",
    "message": "External API access requires the Enterprise plan."
  }
}