External APIs (0.0.1)

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

Retrieves a set of all valid (active, paused, or otherwise non-deleted) subscription contract IDs for a specific customer. This endpoint returns only the contract IDs without detailed subscription information, making it ideal for quick lookups and validation checks.

What Are Valid Subscription Contracts? Valid contracts are subscriptions that exist in the system and haven't been permanently deleted. This includes subscriptions in all states except those that have been hard-deleted or hidden from the system. The contract IDs returned represent subscriptions that can be queried, modified, or managed through other API endpoints.

Contract States Included:

Active States:

• ACTIVE - Currently active and billing recurring subscriptions
• PAUSED - Temporarily paused subscriptions (customer can resume)

Inactive States:

• CANCELLED - Cancelled subscriptions (retained for historical data)
• EXPIRED - Subscriptions that reached their max cycle limit
• FAILED - Subscriptions with payment failures (may be in dunning)

Excluded:

• Hard-deleted subscription records
• Hidden subscriptions (marked for cleanup)
• Subscriptions from test/development that were purged

Use Cases:

1. Customer Portal:

• Check if customer has any subscriptions before showing portal
• Display subscription count in dashboard
• Validate customer access to subscription management

2. Integration & Automation:

• Pre-flight check before bulk operations
• Verify customer has subscriptions before sending emails
• Filter customers for targeted campaigns (has active subscriptions)

3. Validation & Security:

• Verify a specific contract ID belongs to a customer
• Validate user permissions before showing subscription details
• Check authorization for subscription modification requests

4. Analytics & Reporting:

• Count total subscriptions per customer
• Identify customers with multiple subscriptions
• Build customer segmentation based on subscription count

Response Format:

Returns a Set containing Shopify subscription contract IDs.

[123456789, 123456790, 123456791]

Set Properties:

• Unique values: No duplicate contract IDs
• Unordered: IDs are not in any specific order
• Numeric: IDs are Long integers (not GraphQL GIDs)

Common Response Scenarios:

Customer with multiple subscriptions:

[5234567890, 5234567891, 5234567892, 5234567893]

Customer with single subscription:

[5234567890]

Customer with no subscriptions:

[]

Integration Examples:

Example 1: Check if customer has subscriptions

const contractIds = await fetch('/api/external/v2/subscription-customers/valid/12345', {
  headers: { 'X-API-Key': 'your-api-key' }
}).then(r => r.json());

if (contractIds.length > 0) {
  console.log(`Customer has ${contractIds.length} subscriptions`);
  // Show customer portal
} else {
  console.log('Customer has no subscriptions');
  // Redirect to create subscription page
}

Example 2: Validate contract ownership

const customerId = 12345;
const contractIdToVerify = 5234567890;

const validContracts = await fetch(`/api/external/v2/subscription-customers/valid/${customerId}`, {
  headers: { 'X-API-Key': 'your-api-key' }
}).then(r => r.json());

if (validContracts.includes(contractIdToVerify)) {
  console.log('Customer owns this contract - allowing access');
  // Proceed with subscription modification
} else {
  console.log('Unauthorized - contract does not belong to customer');
  // Return 403 Forbidden
}

Performance Characteristics:

Fast Response:

• Lightweight query (returns only IDs, not full subscription data)
• Typical response time: 50-200ms
• Suitable for real-time validation checks

Scalability:

• Efficient even for customers with 100+ subscriptions
• Database query uses indexed customer ID field
• Minimal network payload (just array of numbers)

Important Notes:

Contract ID Format:

• Returns numeric Shopify contract IDs (e.g., 5234567890)
• NOT Shopify GraphQL GIDs (e.g., gid://shopify/SubscriptionContract/...)
• Use these IDs with other Appstle API endpoints

Data Freshness:

• Returns data from Appstle database (not real-time Shopify query)
• Data is updated via webhooks (typically < 1 second lag)
• If data seems stale, use sync endpoint to refresh

Empty Response:

• Empty array [] means customer has no valid subscriptions
• This is NOT an error - it's a valid response
• Returns 200 OK with empty array (not 404)

Security & Authorization:

• Customer ID is validated against authenticated shop
• Cannot query customers from other shops
• API key must have customer read permissions

Best Practices:

1. Use for Validation: Perfect for quick ownership/existence checks
2. Cache Locally: Cache results briefly to reduce API calls
3. Check Empty Array: Always handle empty array case gracefully
4. Combine with Details: Use this for initial check, then fetch full details if needed
5. Avoid Polling: Don't poll this endpoint repeatedly - use webhooks for updates

When to Use vs. Other Endpoints:

Use this endpoint when you:

• Need just the contract IDs (not full subscription details)
• Want to validate a customer has subscriptions
• Need to verify contract ownership for authorization
• Want fast, lightweight responses

Use subscription-customers-detail endpoint when you:

• Need full subscription details (status, products, billing dates, etc.)
• Want to display subscription information to users
• Need to make decisions based on subscription state

Related Endpoints:

• GET /api/external/v2/subscription-customers-detail/valid/{customerId} - Get full subscription details
• GET /api/external/v2/subscription-contract-details - Query subscriptions with filters
• GET /api/external/v2/subscription-contracts/contract-external/{contractId} - Get single contract details

Authentication: Requires valid X-API-Key header or api_key parameter (deprecated)

Synchronizes customer subscription information from Shopify to the Appstle subscription system. This endpoint fetches the latest customer data from Shopify and updates the local database to ensure data consistency across platforms.

What Does This Endpoint Do? This endpoint triggers a synchronization process that pulls customer subscription data from Shopify's GraphQL API and updates the Appstle subscription database with the latest information. It ensures that customer details, subscription statuses, and associated metadata are current and accurate.

Sync Process:

1. Data Retrieval: Fetches customer subscription data from Shopify using their GraphQL API
2. Validation: Validates the retrieved data against existing records
3. Update: Updates customer subscription details in Appstle database
4. Reconciliation: Reconciles any discrepancies between Shopify and Appstle data
5. Logging: Logs all sync activities for audit trail

What Gets Synchronized:

Customer Information:

• Customer ID and Shopify GraphQL ID
• Customer name and email address
• Customer tags and metadata
• Customer acceptance status
• Marketing preferences

Subscription Details:

• Active subscription contracts
• Subscription statuses (ACTIVE, PAUSED, CANCELLED, EXPIRED)
• Next billing dates
• Billing interval and delivery interval
• Subscription line items (products and variants)
• Pricing and discounts

Payment Information:

• Associated payment methods
• Payment instrument status
• Billing address details

Delivery Information:

• Shipping address details
• Delivery method and profile
• Delivery preferences

Use Cases:

1. Data Consistency:

• Resolve data discrepancies between Shopify and Appstle
• Update customer information after changes in Shopify admin
• Sync subscription modifications made directly in Shopify

2. Troubleshooting:

• Fix sync issues for specific customers
• Recover from webhook delivery failures
• Debug customer portal display issues

3. Migration & Integration:

• Initial data sync after app installation
• Re-sync after system maintenance or updates
• Integration testing and validation

4. Customer Support:

• Refresh customer data when assisting with support tickets
• Verify latest subscription status during customer inquiries
• Update data after manual changes in Shopify

When to Use This Endpoint:

Recommended Scenarios:

• Customer reports incorrect subscription data in portal
• After making manual changes to subscriptions in Shopify admin
• When troubleshooting webhook sync failures
• Before running bulk operations on customer subscriptions
• During migration or data reconciliation processes

Avoid Using For:

• Real-time data refresh (webhooks handle this automatically)
• Frequent polling (use webhooks instead to avoid rate limits)
• Bulk syncs of many customers (use batch endpoints or scheduled jobs)

Sync Behavior:

Synchronous Operation:

• Endpoint blocks until sync completes
• Returns void on success
• Throws exception on failure

Data Precedence:

• Shopify data is always treated as source of truth
• Local Appstle data is overwritten with Shopify values
• Custom Appstle-specific fields are preserved

Error Handling:

• Invalid customer ID: Returns 400 Bad Request
• Customer not found in Shopify: Returns 404 Not Found
• Shopify API errors: Returns 502 Bad Gateway
• Rate limit exceeded: Returns 429 Too Many Requests

Important Considerations:

Performance:

• Sync duration depends on number of subscriptions (typically 1-5 seconds)
• May timeout for customers with 100+ active subscriptions
• Consider using asynchronous sync for high-volume customers

Rate Limiting:

• Subject to Shopify GraphQL API rate limits
• Frequent calls may exhaust rate limit budget
• Use webhooks for real-time sync instead of polling this endpoint

Data Integrity:

• Always creates audit log entries for tracking
• Preserves historical data and activity logs
• Does not delete local-only data (e.g., custom notes)

Best Practices:

1. Use Sparingly: Rely on webhooks for automatic sync; use this only when needed
2. Check Logs: Review activity logs after sync to verify changes
3. Validate Results: Query customer data after sync to confirm updates
4. Handle Errors: Implement retry logic with exponential backoff
5. Monitor Rate Limits: Track Shopify API usage to avoid hitting limits

Security Notes:

• Requires valid API key authentication via X-API-Key header
• Customer ID is validated against shop ownership
• Cannot sync customers from other shops
• All sync operations are logged for audit compliance

Response:

• Returns HTTP 204 No Content on successful sync
• No response body returned
• Check activity logs for detailed sync results

Alternative Approaches:

If you need to:

• Sync multiple customers: Use bulk sync endpoint or scheduled job
• Real-time updates: Rely on webhook subscriptions
• Verify data without modifying: Use GET endpoints to retrieve current data

Integration Workflow Example:

1. Customer contacts support about incorrect billing date
2. Support agent checks subscription in Appstle admin
3. Agent makes correction in Shopify admin
4. Agent calls sync endpoint for this customer
5. Sync retrieves latest data from Shopify
6. Appstle database is updated with corrected billing date
7. Customer portal now shows correct date
8. Support ticket resolved

Authentication: Requires valid X-API-Key header or api_key parameter (deprecated)

Retrieves comprehensive subscription contract details for a specific customer, including subscription status, products, billing information, delivery schedules, and more. This endpoint returns full subscription objects with all associated data, making it ideal for displaying subscription management interfaces and detailed analytics.

What This Endpoint Returns: Unlike the contract IDs endpoint which returns only numeric IDs, this endpoint provides complete SubscriptionContractDetailsDTO objects for each of the customer's subscriptions. Each object contains all information needed to display and manage a subscription.

Data Included in Response:

Subscription Identity:

• Subscription contract ID (Shopify numeric ID)
• Subscription GraphQL ID (Shopify GID format)
• Internal Appstle database ID
• Contract creation date

Subscription Status & Lifecycle:

• Current status (ACTIVE, PAUSED, CANCELLED, EXPIRED, FAILED)
• Status reason (why paused/cancelled)
• Next billing date and time
• Contract anchor date
• Cancellation date (if applicable)
• Current billing cycle number
• Min/max cycle limits

Billing Configuration:

• Billing interval (WEEK, MONTH, YEAR)
• Billing interval count (e.g., every 2 weeks)
• Billing policy (pricing details)
• Currency code
• Recurring total price
• Applied discounts and pricing policies

Delivery Configuration:

• Delivery interval (WEEK, MONTH, YEAR)
• Delivery interval count
• Delivery method (SHIPPING, PICK_UP, LOCAL_DELIVERY)
• Delivery policy details
• Delivery price

Products & Line Items:

• All subscribed products and variants
• Product titles, SKUs, and images
• Quantities per product
• Individual line item prices
• Product-specific discounts
• Line item attributes and custom fields

Customer Information:

• Customer ID and GraphQL ID
• Customer name and email
• Customer acceptance status

Address Details:

• Billing address (full address object)
• Shipping address (full address object)
• Address validation status

Payment Information:

• Payment instrument type
• Payment method details (card last 4, etc.)
• Payment gateway used

Order & Fulfillment:

• Last order ID and details
• Last order date
• Order note
• Fulfillment status

Additional Metadata:

• Custom note attributes
• Tags and labels
• Internal flags and settings
• Selling plan ID and group ID
• Shop domain

Use Cases:

1. Customer Portal:

• Display all subscriptions on customer dashboard
• Show subscription details page
• Enable subscription management actions
• Display upcoming order information

2. Admin Dashboard:

• View customer's complete subscription portfolio
• Analyze subscription health and status
• Identify at-risk or high-value subscriptions
• Generate customer subscription reports

3. Customer Support:

• Quick access to all customer subscription details
• Troubleshoot billing or delivery issues
• Verify subscription configurations
• Assist with subscription modifications

4. Analytics & Reporting:

• Calculate customer lifetime value
• Analyze subscription mix per customer
• Track subscription frequency distribution
• Identify cross-sell/upsell opportunities

5. Integration & Automation:

• Sync subscription data to CRM/analytics platforms
• Trigger workflows based on subscription details
• Build custom reporting dashboards
• Export subscription data for analysis

Response Format:

Returns an array of SubscriptionContractDetailsDTO objects:

[
  {
    "id": 789,
    "subscriptionContractId": 5234567890,
    "status": "ACTIVE",
    "nextBillingDate": "2024-03-15T00:00:00Z",
    "billingInterval": "MONTH",
    "billingIntervalCount": 1,
    "deliveryInterval": "MONTH",
    "deliveryIntervalCount": 1,
    "currencyCode": "USD",
    "currentTotalPrice": "49.99",
    "customerId": 12345,
    "customerEmail": "customer@example.com",
    "lineItems": [...],
    "billingAddress": {...},
    "shippingAddress": {...}
  },
  {...}
]

Response Scenarios:

Customer with no subscriptions:

[]

Returns empty array with 200 OK status (not an error).

Customer with multiple subscriptions: Array contains multiple subscription objects, each representing a separate subscription contract.

Performance Considerations:

Response Size:

• Each subscription object can be 5-50 KB depending on line items
• Customer with 10 subscriptions: ~100-500 KB response
• Consider pagination or filtering for customers with 20+ subscriptions

Query Performance:

• Typical response time: 200-500ms
• Slower for customers with many subscriptions or complex products
• Database query is optimized with indexed lookups

Best Practices:

1. Cache Results: Cache response data to minimize API calls
2. Filter Client-Side: Filter/sort subscriptions on client after retrieval
3. Selective Display: Don't display all fields if not needed
4. Handle Empty Array: Always gracefully handle case with no subscriptions
5. Optimize Images: Product images can be large - lazy load if displaying

Data Freshness:

• Data is retrieved from Appstle database (not real-time Shopify query)
• Updated via webhooks with < 1 second lag typically
• Use sync endpoint if data appears stale

Security Notes:

• Customer ID is validated against authenticated shop
• Returns only subscriptions belonging to specified customer
• Cannot access customers from other shops
• Sensitive payment details (full card numbers) are never returned

Comparison with Other Endpoints:

vs. GET /subscription-customers/valid/{customerId}:

• This endpoint: Returns complete subscription details
• Valid contracts endpoint: Returns only contract IDs
• Use this when you need full subscription information

vs. GET /subscription-contract-details:

• This endpoint: Filtered by single customer
• Contract details endpoint: Query across all customers with filters
• Use this for customer-specific views

vs. GET /subscription-contracts/contract-external/{contractId}:

• This endpoint: All contracts for a customer
• Contract external endpoint: Single contract with Shopify raw data
• Use this for customer overview, other for detailed single contract

Authentication: Requires valid X-API-Key header or api_key parameter (deprecated)