Get valid membership contract IDs for customer
Retrieves a list of all valid (active, paused, or pending) membership contract IDs associated with a specific customer. This endpoint is useful for quickly checking which memberships a customer has without retrieving full contract details.
Key Features:
- Quick Lookup: Returns only contract IDs, not full contract details
- Active Memberships Only: Excludes cancelled or expired contracts
- Set Response: Returns unique contract IDs (no duplicates)
- Fast Performance: Lightweight query for list views
Included Membership Statuses:
- ACTIVE: Currently active recurring memberships
- PAUSED: Temporarily paused but valid memberships
- PENDING: Scheduled to start in the future
Excluded Membership Statuses:
- CANCELLED: Customer-cancelled memberships
- EXPIRED: Reached max cycles or end date
- FAILED: Failed billing with no recovery
Common Use Cases:
- Membership Count: Quickly determine how many active memberships a customer has
- Access Control: Verify customer has valid memberships before showing portal
- List Navigation: Build dropdown or list of customer’s memberships
- Bulk Operations: Get all contract IDs for batch processing
- Validation: Check if customer has any active memberships
- Dashboard Display: Show membership count without full data
Example Response:
[12345, 12346, 12389]
Parameters:
- customerId (required, path): The Shopify customer ID
Response: Returns a Set of Long values representing valid membership contract IDs
Authentication: Requires API key authentication via X-API-Key header or api_key parameter
Headers
Path Parameters
Shopify customer ID
Query Parameters
API Key (Deprecated - Use Header X-API-Key instead)
Response
Valid membership contract IDs retrieved successfully (may be empty set if customer has no active memberships)
The response is of type string.