Skip to main content
Appstle Memberships gives you programmatic access to every part of your membership program — from creating tiered plans and gating content to processing renewals and tracking analytics. Whether you’re connecting a CRM, building a mobile app, or customizing your storefront member portal, the APIs deliver the flexibility you need.

​
Available APIs

Appstle Memberships exposes two REST API surfaces. Pick the one that matches where your code runs:
  • Admin API — server-side, authenticated with X-API-Key. For backend integrations, admin dashboards, bulk operations, mobile apps, and third-party sync. Browse the full reference under Admin API in the sidebar.
  • Customer Portal API — customer-facing, accessed through Shopify App Proxy. For member self-service portals, theme integrations, and gated content. Browse the full reference under Customer Portal API in the sidebar.

​
Which API should you use?

  • You are building server-side integrations and automation workflows
  • You are managing memberships from your backend or a CRM
  • You are building admin dashboards or reporting tools
  • You are automating bulk operations across your member base
  • You are integrating with email platforms, analytics tools, or helpdesks
  • You are building a mobile app (iOS or Android)
Admin API requests require an X-API-Key header. Keys are created in the Appstle dashboard under Settings → API Key Management. Never expose keys in client-side code.

​
Key features

Membership plans

Create and manage tiered membership plans with flexible pricing and billing cycles — monthly, annual, or custom intervals.

Member management

Retrieve and sync member data, plan status, and access entitlements across your systems in real time.

Access control

Gate content, collections, and pricing based on membership status and tier using customer tags and metafields.

Billing & contracts

Manage membership contracts, renewals, and billing attempts. Handle dunning, pauses, and cancellations programmatically.

Member benefits

Configure perks, discounts, and exclusive access rules per membership tier. Swap plans and roll back automatically on failed payments.

Notifications

Automate member communications for renewals, expirations, billing failures, and upgrades via Shopify Flow or webhooks.

Analytics

Access membership metrics, churn data, MRR projections, and revenue analytics using contract list endpoints and billing events.

Shopify native

Deep integration with Shopify Flow, metafields, customer tags, and the App Proxy — no separate infrastructure required.

​
Base URL

All Admin API endpoints use: 
https://membership-admin.appstle.com/api/external/v2/
Customer Portal API endpoints are accessed through your store’s Shopify App Proxy — no separate base URL is needed.

​
HTTP status codes

All API responses use standard HTTP status codes.
CodeMeaning
200Success
201Resource created
400Bad request — invalid parameters
401Unauthorized — missing or invalid API key
403Forbidden — key lacks required permissions
404Not found
429Rate limit exceeded
500Server error
Error responses follow this shape: 
{
  "error": "Unauthorized",
  "message": "Invalid API key provided",
  "status": 401
}

​
Next steps

Authentication

Create your API key and learn how to authenticate requests.

Quickstart

Make your first API call in under five minutes.

Integration guide

Explore common integration patterns for CRMs, email platforms, and access control.