# List Subscriptions

Retrieves a list of subscriptions for a practice group.

Endpoint: GET /v1/subscriptions
Version: 1.0.0
Security: apiKeyAuth, practiceGroupId

## Query parameters:

  - `patient_id` (string, required)

  - `page_index` (integer)

  - `page_size` (integer)

  - `order_by[]` (array)
    Enum: "created_at", "expires_on", "cancelled_at", "members"

  - `order_descending[]` (array)

  - `scheme_id` (string)

  - `scheme_name` (string)

  - `status` (string)
    Enum: "cancelled", "expired", "active", "not_started"

## Response 200 fields (application/json):

  - `data` (array, required)

  - `data.id` (string, required)

  - `data.subscription_id` (string, required)

  - `data.scheme` (object, required)

  - `data.scheme.name` (string, required)

  - `data.customer` (object,null, required)

  - `data.status` (string, required)

  - `data.members_count` (number, required)

  - `data.created_at` (string,null, required)

  - `data.expires_at` (string,null, required)

  - `data.cancelled_at` (string,null, required)

  - `count` (number, required)

## Response 400 fields (application/json):

  - `error` (boolean, required)

  - `statusCode` (number, required)

  - `message` (array, required)

  - `message.code` (string, required)

  - `message.expected` (string, required)

  - `message.path` (array, required)


## Response 401 fields

## Response 404 fields

## Response 500 fields