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

# Abonnes



## OpenAPI

````yaml GET /billing/subscribers
openapi: 3.1.0
info:
  title: Mysoleas API
  version: 3.0.0
  description: >-
    Nouvelle architecture Mysoleas: gateway de paiement et authentification
    OAuth 2.0.
servers:
  - url: https://api.mysoleas.com
    description: Gateway Mysoleas
  - url: https://account.mysoleas.com
    description: Authentification Mysoleas
security:
  - bearerAuth: []
tags:
  - name: Auth
  - name: Plugin
  - name: Payment links
  - name: Subscriptions
  - name: Collections
  - name: Disbursements
  - name: Catalog
paths:
  /billing/subscribers:
    get:
      tags:
        - Subscriptions
      summary: Lister les abonnes d'un marchand
      parameters:
        - $ref: '#/components/parameters/SubscriptionStatus'
        - $ref: '#/components/parameters/CustomerEmail'
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          $ref: '#/components/responses/SubscriberListSuccess'
components:
  parameters:
    SubscriptionStatus:
      name: status
      in: query
      schema:
        type: string
        enum:
          - ACTIVE
          - SUSPENDED
          - CANCELLED
          - EXPIRED
    CustomerEmail:
      name: customer_email
      in: query
      schema:
        type: string
        format: email
    Page:
      name: page
      in: query
      schema:
        type: integer
        minimum: 1
        default: 1
    Limit:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 25
  responses:
    SubscriberListSuccess:
      description: Liste d'abonnes
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SubscriberListApiResponse'
  schemas:
    SubscriberListApiResponse:
      allOf:
        - $ref: '#/components/schemas/ApiResponseBase'
        - type: object
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/Subscriber'
    ApiResponseBase:
      type: object
      properties:
        code:
          type: integer
          example: 200
        success:
          type: boolean
          example: true
        locale:
          type: string
          example: fr
        message:
          type: string
        meta:
          type: object
          additionalProperties: true
    Subscriber:
      type: object
      properties:
        subscription_reference:
          type: string
        subscribed_at:
          type:
            - string
            - 'null'
        customer_email:
          type: string
        customer_phone:
          type:
            - string
            - 'null'
        amount:
          type: integer
        currency:
          type: string
        description:
          type: string
        status:
          type: string
        next_payment_at:
          type:
            - string
            - 'null'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````