Get valid subscription contract IDs for customer

Retrieves a list of all valid (active, paused, or pending) subscription contract IDs associated with a specific customer. This endpoint is useful for quickly checking which subscriptions a customer has without retrieving full contract details.

Full behavior, validation rules, and side effects

Key Features:

• Quick Lookup: Returns only contract IDs, not full contract details
• Active Subscriptions Only: Excludes cancelled or expired contracts
• Set Response: Returns unique contract IDs (no duplicates)
• Fast Performance: Lightweight query for list views

Included Subscription Statuses:

• ACTIVE: Currently active recurring subscriptions
• PAUSED: Temporarily paused but valid subscriptions
• PENDING: Scheduled to start in the future

Excluded Subscription Statuses:

• CANCELLED: Customer-cancelled subscriptions
• EXPIRED: Reached max cycles or end date
• FAILED: Failed billing with no recovery

Common Use Cases:

• Subscription Count: Quickly determine how many active subscriptions a customer has
• Access Control: Verify customer has valid subscriptions before showing portal
• List Navigation: Build dropdown or list of customer’s subscriptions
• Bulk Operations: Get all contract IDs for batch processing
• Validation: Check if customer has any active memberships
• Dashboard Display: Show subscription 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 subscription contract IDs

Authentication: Requires API key authentication via X-API-Key header or api_key parameter

GET /api/external/v2/subscription-customers/valid/{customerId}

Get valid subscription contract IDs for customer

cURL

curl --request GET \
  --url https://membership-admin.appstle.com/api/external/v2/subscription-customers/valid/{customerId}

200

"<string>"

Headers

X-API-Key · string

Path Parameters

customerId · integer<int64> · required

Shopify customer ID

Query Parameters

api_key · string

API Key (Deprecated - Use Header X-API-Key instead)

Response

200

application/json

Valid subscription contract IDs retrieved successfully (may be empty set if customer has no active subscriptions)

The response is of type string.