> ## Documentation Index
> Fetch the complete documentation index at: https://developers.appstle.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve customers with subscriptions

> Returns a paginated list of customers who have subscription contracts. Supports filtering by customer name, email, and subscription count.



## OpenAPI

````yaml /subscription/admin-api-swagger.json get /api/external/v2/subscription-contract-details/customers
openapi: 3.0.1
info:
  description: >-
    Comprehensive API documentation for managing subscriptions, payments, and
    related operations. These APIs allow you to programmatically manage
    subscription lifecycles, handle payments, configure products, and integrate
    subscription functionality into your applications.
  title: Admin APIs
  version: 0.0.1
servers:
  - url: https://subscription-admin.appstle.com
security: []
tags:
  - description: >-
      Core APIs for managing the complete subscription lifecycle including
      creation, updates, pausing, resuming, and cancellation of subscriptions.
    name: Subscription Management
  - description: >-
      APIs for managing subscription payment methods, processing payments,
      handling payment retries, and updating billing information.
    name: Subscription Payments
  - description: >-
      APIs for managing subscription contracts including delivery schedules,
      pricing, order notes, billing cycles, and shipping addresses.
    name: Subscription Contracts
  - description: >-
      APIs for managing products within subscriptions including adding,
      removing, updating quantities, and swapping products.
    name: Subscription Products
  - description: >-
      APIs for handling billing operations, payment processing, and financial
      transactions related to subscriptions.
    name: Billing & Payments
  - description: >-
      APIs for managing discounts and promotional codes applied to
      subscriptions.
    name: Subscription Discounts
  - description: >-
      APIs for managing one-time add-on products that can be purchased alongside
      recurring subscription items.
    name: Subscription One-Time Products
  - description: >-
      APIs for managing subscription plans, pricing tiers, and plan
      configurations.
    name: Subscription Plans
  - description: >-
      APIs for managing customizable product boxes and bundles where customers
      can select multiple items.
    name: Build-a-Box & Bundles
  - description: >-
      APIs for managing the product catalog including product information,
      variants, and inventory.
    name: Product Catalog
  - description: >-
      APIs for managing operational settings, configurations, and administrative
      functions.
    name: Operations & Settings
  - description: >-
      APIs powering the customer-facing portal where subscribers can manage
      their own subscriptions.
    name: Customer Portal
  - description: APIs for managing customer information, profiles, and account details.
    name: Customers
  - description: >-
      APIs for retrieving aggregated subscription data, customer subscription
      history, and account-level subscription information.
    name: Subscription Data
  - description: >-
      APIs for managing delivery profiles, shipping rates, free shipping
      configuration, and delivery method options on subscriptions.
    name: Delivery & Shipping
  - description: >-
      APIs for managing storefront customization including custom CSS, theme
      settings, label translations, and merchant-defined widget configuration.
    name: Customization
  - description: >-
      APIs for configuring cancellation flows, retention offers, cancellation
      reason management, and win-back automation.
    name: Customer Retention
paths:
  /api/external/v2/subscription-contract-details/customers:
    get:
      tags:
        - Customers
        - Subscription Contracts
      summary: Retrieve customers with subscriptions
      description: >-
        Returns a paginated list of customers who have subscription contracts.
        Supports filtering by customer name, email, and subscription count.
      operationId: getAllSubscriptionContractDetailsByShop
      parameters:
        - deprecated: true
          description: API Key (Deprecated - Use X-API-Key header instead)
          in: query
          name: api_key
          required: false
          schema:
            type: string
        - description: API Key for authentication
          in: header
          name: X-API-Key
          required: true
          schema:
            type: string
        - description: Filter customers by name (partial match supported)
          in: query
          name: name
          required: false
          schema:
            type: string
        - description: Filter customers by exact email address
          in: query
          name: email
          required: false
          schema:
            type: string
        - description: >-
            When true, returns only customers who have more than one active
            subscription
          example: false
          in: query
          name: activeMoreThanOneSubscription
          required: false
          schema:
            default: false
            type: boolean
        - description: Pagination parameters (page number and size)
          example:
            page: 0
            size: 10
            sort:
              - id,desc
          in: query
          name: pageable
          required: true
          schema:
            $ref: '#/components/schemas/Pageable'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/CustomerInfo'
                type: array
          description: Successfully retrieved customer list
        '401':
          content:
            '*/*':
              schema:
                items:
                  $ref: '#/components/schemas/CustomerInfo'
                type: array
          description: Authentication required
        '403':
          content:
            '*/*':
              schema:
                items:
                  $ref: '#/components/schemas/CustomerInfo'
                type: array
          description: Insufficient permissions to access customer data
components:
  schemas:
    Pageable:
      properties:
        page:
          format: int32
          minimum: 0
          type: integer
        size:
          format: int32
          minimum: 1
          type: integer
        sort:
          items:
            type: string
          type: array
      type: object
    CustomerInfo:
      properties:
        activeSubscriptions:
          format: int64
          type: integer
        customerId:
          format: int64
          type: integer
        email:
          type: string
        inActiveSubscriptions:
          format: int64
          type: integer
        lifetimeValue:
          format: double
          type: number
        name:
          type: string
        nextOrderDate:
          format: date-time
          type: string
      type: object

````