Skip to content
🔧 Admin APIs
/
/
syncCustomerInfoV2

External (0.0.1)

Download OpenAPI description
admin-api-swagger.json
admin-api-swagger.yaml
Languages
Servers
https://membership-admin.appstle.com

Shipping & Delivery Profiles

APIs for managing Shopify delivery profiles, shipping rates, zones, and free shipping configuration for subscription memberships

Operations

Customer Discount History

APIs for retrieving historical discount code usage and redemption information for membership contracts

Operations

Cancellation Flow Configuration

APIs for managing membership cancellation flow settings including retention offers, survey questions, and cancel confirmation screens

Operations

Billing & Orders

APIs for managing membership billing attempts, recurring orders, payment retries, order history, and order skipping

Operations

One-Time Add-Ons

APIs for managing one-time product additions to upcoming subscription orders, including adding, retrieving, and removing one-off items

Operations

Membership Plans

APIs for managing membership/subscription plan groups, including creating plans, configuring discounts, billing intervals, and assigning products to plans

Operations

Product Bundles

APIs for managing subscription product bundles, bundle configurations, item grouping, and bundle-specific discount codes

Operations

Custom CSS Styling

APIs for retrieving custom CSS styles applied to subscription widgets and customer portal for theme customization

Operations

Customer Portal Configuration

APIs for managing customer portal settings including UI customization, text labels, feature toggles, and branding options for the member self-service portal

Operations

Membership Contracts

APIs for managing membership/subscription contracts including creation, updates, status changes, line items, discounts, and billing operations

Operations

Generate customer portal authentication token

Request

Generates an authentication token for customer portal access using either customer ID or email address. This token can be used to create magic links or authenticate API requests on behalf of a customer.

Key Features:

  • Flexible Lookup: Find customer by Shopify customer ID OR email address
  • JWT Token: Returns cryptographically secure JSON Web Token
  • Portal Access: Token grants access to customer subscription management portal
  • API Authentication: Can be used in subsequent API calls for customer-specific operations
  • Time-Limited: Token expires after configured duration (default: 24-72 hours)

Request Parameters: Provide either customerId OR email (not both):

  • customerId: Shopify customer ID (numeric string, e.g., "6789012345")
  • email: Customer's email address as registered in Shopify

Response Contains:

  • customerId: Shopify customer ID associated with the token
  • token: JWT authentication token for portal access
  • shop: Store domain the customer belongs to
  • expiresAt: Token expiration timestamp (ISO 8601)

Common Use Cases:

  • Generate token to construct customer portal magic links
  • Authenticate customer in headless commerce implementations
  • Validate customer identity before allowing subscription changes
  • Create custom portal integrations with embedded authentication
  • Server-side customer lookup when only email is available
  • Build custom subscription management UIs with API authentication
  • Integrate with external CRM systems requiring customer tokens

Token Usage: Once generated, the token can be:

  1. Embedded in magic link URLs: https://portal.example.com?token={token}
  2. Used as Bearer token in Authorization headers for API calls
  3. Stored temporarily for customer session management
  4. Passed to frontend applications for customer-specific operations

Security Best Practices:

  • Never expose tokens in client-side logs or browser storage
  • Transmit tokens only over HTTPS
  • Implement token rotation for long-lived sessions
  • Validate token expiration before use
  • Revoke tokens when customer logs out or changes credentials

Error Handling:

  • If neither customerId nor email is provided, returns 400 Bad Request
  • If both customerId and email are provided, customerId takes precedence
  • If customer not found, returns 404 Not Found
  • Invalid email format returns 400 Bad Request

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

Query
api_keystring

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

customerIdstring

Shopify customer ID (provide either customerId OR email)

Example: customerId=6789012345
emailstring

Customer email address (provide either customerId OR email)

Example: email=customer@example.com
Headers
X-API-Keystring
curl -i -X GET \
  'https://membership-admin.appstle.com/api/external/v2/customer-portal-token?api_key=string&customerId=6789012345&email=customer%40example.com' \
  -H 'X-API-Key: string'

Responses

Customer portal token generated successfully, returns customer ID and authentication token

Bodyapplication/json
customerIdinteger(int64)
tokenstring
Response
application/json
{
  "customerId": 0,
  "token": "string"
}

syncCustomerInfoV2

Request

Path
customerIdinteger(int64)required
Headers
X-API-Keystring
curl -i -X DELETE \
  'https://membership-admin.appstle.com/api/external/v2/subscription-customers/sync-info/{customerId}' \
  -H 'X-API-Key: string'

Responses

OK

Cancel membership/subscription contract

Request

Cancels a membership/subscription contract and sends cancellation confirmation emails. This endpoint terminates the recurring subscription and processes all cancellation workflows.

Cancellation Process:

  • Contract Termination: Marks subscription as cancelled in Shopify
  • Billing Stop: Prevents future billing attempts
  • Email Notification: Sends cancellation confirmation to customer
  • Activity Logging: Records cancellation event with source and feedback
  • Feedback Capture: Optional cancellation reason for analytics

Key Features:

  • Immediate Cancellation: Stops subscription processing immediately
  • Feedback Collection: Capture customer cancellation reasons
  • Automated Emails: Customer receives cancellation confirmation
  • Activity Tracking: Logs cancellation to activity history
  • Source Attribution: Tracks whether cancellation came from customer portal or API

Validation Checks:

  • Contract Ownership: Verifies contract belongs to authenticated shop
  • Minimum Cycles: Checks if minimum billing cycles requirement is met (if configured)
  • Freeze Status: Validates subscription is not frozen
  • Existing Status: Ensures contract is not already cancelled

Email Notifications:

  • Sends cancellation confirmation to customer email
  • Includes subscription details and cancellation date
  • Uses customizable email templates from shop settings

Use Cases:

  • Allow customers to cancel from custom portals or mobile apps
  • Bulk cancellation workflows via external systems
  • Integration with customer service platforms
  • Automated cancellation based on business rules
  • Churn management and retention workflows

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

Path
idinteger(int64)required

Membership contract ID to cancel

Example: 123456789
Query
api_keystring

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

cancellationFeedbackstring

Optional cancellation reason/feedback from customer

Example: cancellationFeedback=Too expensive
Headers
X-API-Keystring
curl -i -X DELETE \
  'https://membership-admin.appstle.com/api/external/v2/subscription-contracts/123456789?api_key=string&cancellationFeedback=Too+expensive' \
  -H 'X-API-Key: string'

Responses

Subscription successfully cancelled, confirmation email sent

Response
No content

Bundle Settings

APIs for managing subscription bundle configuration settings including bundle behavior, pricing rules, and display options

Operations

Customer Payment Methods

APIs for managing customer payment methods, payment tokens, and payment method retrieval for subscriptions

Operations

Product Swap Rules

APIs for retrieving product swap/substitution options allowing members to exchange subscription items based on configured swap rules and variant groups

Operations

Subscription Contract Management

Operations

Subscription Billing

Operations

Billing Attempts

Operations