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

# Get Services

> Retrieves a list of services linked to the user's account based on the provided login credentials, including details such as service status, billing cycle, pricing, and location.



## OpenAPI

````yaml post /kvm/v2/get/services
openapi: 3.0.0
info:
  title: EDIS Global ORDER API
  description: >
    Welcome to EDIS Global ORDER API 🚀

    The EDIS Global ORDER API allows seamless integration with our
    infrastructure to automate the entire product lifecycle (ordering and
    cancellations).


    Whether you’re integrating into your billing system or automating your
    service orders, our ORDER API makes managing the product lifecycle of EDIS
    Global services simple and effective. Below is a quick overview to help you
    get started.


    🚀 **Get Started Here**

    Follow these steps to begin using the EDIS Global ORDER API:


    - **Authentication:** Ensure you are authenticated (WHMCS username and
    password)

    - **Explore the Endpoints:** Use the endpoints below to order and cancel VPS
    services in any of our worldwide server locations.


    Available API Endpoints:


    **Payment Methods**

    - POST `get payment methods`
      Retrieve the available payment methods for your order.

    **Billing Cycles**

    - POST `get billingcycles`
      Get available billing cycles for different products.

    **Locations**

    - POST `get locations`
      Fetch all available VPS locations across the globe.

    **Products**

    - POST `get products`
      List the available VPS products and configurations.

    **Place an Order**

    - POST `add order`
      Add a new VPS order to the EDIS Global infrastructure.

    **Cancel a Product**

    - POST `cancel product`
      Cancel a specific product or VPS service.

    For more details on the EDIS Global ORDER API, please refer to the full
    documentation, and feel free to reach out if you have any questions or need
    assistance.


    Happy Coding!

    The EDIS Global Team
  version: 1.0.0
servers:
  - url: https://order.edisglobal.com
    description: Sandbox Server
security: []
paths:
  /kvm/v2/get/services:
    servers:
      - url: https://order.edisglobal.com
        description: Production Server
    post:
      summary: Retrieve user services
      description: >-
        Retrieves a list of services linked to the user's account based on the
        provided login credentials, including details such as service status,
        billing cycle, pricing, and location.
      operationId: getUserServices
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  example: user@example.com
                  description: Your WHMCS email address.
                pw:
                  type: string
                  example: securepassword123
                  description: Your WHMCS password.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_services_response_200'
              examples:
                successWithServices:
                  summary: Services found
                  value:
                    services:
                      - service_id: 312845
                        kvm_id: kvm_112234_457381
                        status: active
                        price:
                          billingcycle: Monthly
                          amount: '4.99'
                          currency: EUR
                        creation_date: '2025-03-11'
                        key_date: '2025-04-11'
                        paymentmethod: cryptomus
                        plan: KVM BASIC
                        location: Austria, Vienna
                    status: success
                successNoServices:
                  summary: No services found
                  value:
                    services: []
                    status: success
        '400':
          description: Bad request - Invalid parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_services_response_400'
        '401':
          description: Unauthorized - Invalid WHMCS credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_services_response_401'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_services_response_500'
components:
  schemas:
    get_services_response_200:
      type: object
      properties:
        status:
          type: string
          example: success
          description: >-
            Request status. Returns `success` when the request was processed
            correctly.
        services:
          type: array
          description: >-
            List of services linked to the authenticated account. Returns an
            empty array if no services exist.


            ⚠️ **To view detailed descriptions for each service field, click
            “Show child attributes” below.**
          items:
            $ref: '#/components/schemas/service_item'
    get_services_response_400:
      type: object
      properties:
        status:
          type: string
          example: error
        errormsg:
          type: string
          example: Invalid email or password.
          description: Error message if authentication fails.
    get_services_response_401:
      type: object
      properties:
        status:
          type: string
          example: error
        errormsg:
          type: string
          example: Invalid WHMCS credentials.
    get_services_response_500:
      type: object
      properties:
        status:
          type: string
          example: error
        errormsg:
          type: string
          example: Internal server error. Please try again later.
          description: General server-side error message.
    service_item:
      type: object
      properties:
        service_id:
          type: integer
          example: 312845
          description: Unique WHMCS service identifier for the VPS.
        kvm_id:
          type: string
          example: kvm_114732_602381
          description: EDIS KVM instance identifier.
        status:
          type: string
          enum:
            - active
            - suspended
            - terminated
          example: active
          description: >-
            Service lifecycle status. Possible values: `active`, `suspended`,
            `terminated`.
        price:
          type: object
          description: Structured pricing information for the service.
          properties:
            billingcycle:
              type: string
              example: Monthly
              description: Billing cycle of the service.
            amount:
              type: string
              example: '4.99'
              description: Recurring price amount.
            currency:
              type: string
              example: EUR
              description: Currency of the service price.
        creation_date:
          type: string
          format: date
          example: '2025-03-11'
          description: Creation date of the VPS.
        key_date:
          type: string
          format: date
          example: '2026-03-19'
          description: Next invoice due date for this service.
        paymentmethod:
          type: string
          example: cryptomus
          description: Payment method assigned to the service.
        plan:
          type: string
          example: KVM BASIC
          description: Product/plan name of the VPS.
        location:
          type: string
          example: Austria, Vienna
          description: VPS hosting location.

````