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.Documentation Index
Fetch the complete documentation index at: https://appstleinc-aeca3e0a.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Available APIs
Admin API
Server-side API for managing memberships, access rules, member data, and billing. Authenticate with an API key and call from your backend, mobile app, or automation tool.Authentication:
X-API-Key headerUse cases: Backend integrations, admin dashboards, bulk operations, mobile apps, third-party system syncCustomer Portal API
Customer-facing API for membership self-service, delivered via Shopify App Proxy. Members can view their plan, manage their membership, and access gated content directly from your storefront.Authentication: Customer session (must be logged in)Use cases: Custom member portals, theme integrations, self-service membership management, gated content
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.
Which API should you use?
- Admin API
- Customer Portal API
Use the Admin API when you are building anything outside your Shopify storefront:
- Server-side integrations and automation workflows
- Managing memberships from your backend or a CRM
- Building admin dashboards or reporting tools
- Automating bulk operations across your member base
- Integrating with email platforms, analytics tools, or helpdesks
- Building mobile applications (iOS or Android)
X-API-Key header) and must only be called from server-side code. Never expose your API key in browser JavaScript or public repositories.Base URL
All Admin API requests use the following base URL:Response format
All API responses follow standard HTTP status codes.| Status | Meaning |
|---|---|
200 | Success — request completed |
201 | Created — resource created successfully |
400 | Bad Request — invalid parameters |
401 | Unauthorized — invalid or missing API key |
403 | Forbidden — key lacks required permissions |
404 | Not Found — resource does not exist |
429 | Too Many Requests — rate limit exceeded |
500 | Server Error — something went wrong on our end |
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.