# Get Subscription List

**Description:**  
Retrieves a paginated list of subscriptions. The response includes details of each subscription, and filtering options can be applied via query parameters.

**Url Parameter Parameters:**

- `status` (string, optional) – Filter subscriptions by status (e.g., `SENT`, `ONGOING`, `COMPLETED, CANCELLED`).

**Query Parameters:**

- `page` (integer, optional) – The page number for pagination. Default: `1`.
- `phone` (string, optional) – Filter subscriptions by phone.
- `customerName` (string, optional) – Retrieve subscriptions associated with a specific customer.
- `startDate` (date, optional) – Filter subscriptions that started on or after this date (Format: `YYYY-MM-DD`).
- `endDate` (date, optional) – Filter subscriptions that ended on or before this date (Format: `YYYY-MM-DD`). startDate and endDate should be used together.

**Authentication**

This endpoint requires authentication using a **Bearer Token**. The client must send the token in the `Authorization` header for every request.

**Example Authentication Header:**

<div class="contain-inline-size rounded-md border-[0.5px] border-token-border-medium relative bg-token-sidebar-surface-primary dark:bg-gray-950" id="bkmrk-authorization%3A-beare"><div class="overflow-y-auto p-4" dir="ltr">`<span class="hljs-section">Authorization: Bearer YOUR_ACCESS_TOKEN</span>`</div></div>If the token is missing or invalid, the API will return a `401 Unauthorized` response.

<table border="1" id="bkmrk-endpoint-%3A-https%3A%2F%2Fd" style="border-collapse: collapse; width: 100%; height: 1160.85px;"><colgroup><col style="width: 33.3745%;"></col><col style="width: 2.22497%;"></col><col style="width: 64.4005%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Endpoint</td><td style="height: 29.7969px;">:</td><td style="height: 29.7969px;"><span data-offset-key="ftu67-3-0"><span data-text="true">[https://demo-api.frontpayment.no/api/v1/connect/subscriptions/list/](https://demo-api.frontpayment.no/api/v1/connect/subscriptions/list/){status?}</span></span></td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Method</td><td style="height: 29.7969px;">:</td><td style="height: 29.7969px;">GET</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Authorization</td><td style="height: 29.7969px;">:</td><td style="height: 29.7969px;">Bearer</td></tr><tr style="height: 486.094px;"><td style="height: 486.094px;" valign="top" width="132">Response Structure

</td><td style="height: 486.094px;" valign="top" width="18">: </td><td style="height: 486.094px;">```json
{
  "status_code": 200,
  "status_message": "OK",
  "message": "subscriptionRetrieveSuccessfully",
  "is_data": true,
  "data": [
    {
      "subscriptionUuid": "String",
      "orderUuid": "String",
      "repeats": "Integer",
      "frequency": "String",
      "amount": "Float",
      "currency": "String",
      "createdAt": "String",
      "customerName": "String",
      "clientName": "String",
      "customerEmail": "String",
      "countryCode": "String",
      "msisdn": "String",
      "status": "String",
      "isPaid": "Boolean",
      "isRefundable": "Boolean",
      "numberOfPaidCycles": "Integer"
    }
  ],
  "metaData": {
    "total": "Integer",
    "perPage": "Integer",
    "currentPage": "Integer",
    "lastPage": "Integer"
  },
  "links": {
    "previous": null,
    "next": "https://fpgo-backend.test/api/v1/connect/subscriptions/failed/list?page=2"
  }
}
```

  
</td></tr><tr style="height: 486.094px;"><td style="height: 486.094px;" valign="top" width="132">Example Response

</td><td style="height: 486.094px;" valign="top" width="18">: </td><td style="height: 486.094px;">```json
{
    "status_code": 200,
    "status_message": "OK",
    "message": "subscriptionRetrieveSuccessfully",
    "is_data": true,
    "data": [
     
        {
            "subscriptionUuid": "SUB3959080783",
            "orderUuid": "ODR1530327942",
            "repeats": 12,
            "frequency": "month",
            "amount": 2000,
            "currency": "NOK",
            "createdAt": "07.11.2023",
            "customerName": "420 Test",
            "clientName": "Front Payment AS",
            "customerEmail": "local-420test@yopmail.com",
            "countryCode": "+47",
            "msisdn": "46567468",
            "status": "EXPIRED",
            "isPaid": false,
            "isRefundable": false,
            "numberOfPaidCycles": 0,
        },
        {
            "subscriptionUuid": "SUB4132380543",
            "orderUuid": "ODR2167679196",
            "repeats": 12,
            "frequency": "month",
            "amount": 2000,
            "currency": "NOK",
            "createdAt": "05.11.2023",
            "customerName": "420 Test",
            "clientName": "Front Payment AS",
            "customerEmail": "local-420test@yopmail.com",
            "countryCode": "+47",
            "msisdn": "46567468",
            
            "status": "ONGOING",
            "isPaid": true,
            "isRefundable": true,
             "numberOfPaidCycles": 4,
        },
        {
            "subscriptionUuid": "SUB2007828928",
            "orderUuid": "ODR187366332",
            "repeats": 12,
            "frequency": "month",
            "amount": 2000,
            "currency": "NOK",
            "createdAt": "05.11.2023",
            "customerName": "420 Test",
            "clientName": "Front Payment AS",
            "customerEmail": "local-420test@yopmail.com",
            "countryCode": "+47",
            "msisdn": "46567468",
            "status": "ONGOING",
            "isPaid": true,
            "isRefundable": true,
            "numberOfPaidCycles": 1,
        },
      ....
    ],
    "metaData": {
        "total": 3,
        "perPage": 50,
        "currentPage": 1,
        "lastPage": 1
    },
    "links": {
        "previous": null,
        "next": "https://fpgo-backend.test/api/v1/connect/subscriptions/list?page=2"
    }
}
```

</td></tr></tbody></table>