# Получение списка активных подписок

<mark style="color:blue;">`GET`</mark>&#x20;

```json
GET https://unitpay.ru/api

method             = listSubscriptions
params[projectId]  = 123456789
params[secretKey]  = key

```

#### Path Parameters

<table><thead><tr><th width="171.22222900390625">Name</th><th width="132.4444580078125">Type</th><th>Description</th></tr></thead><tbody><tr><td>projectId</td><td>integer</td><td>ID вашего проекта в системе UnitPay</td></tr><tr><td>secretKey</td><td>string</td><td>Секретный ключ, доступен в настройках проекта</td></tr></tbody></table>

#### Успешный ответ

```json
{
  "result": [
    {
      "subscriptionId":  5961196,
      "description":     "test_unitpay",
      "status":          "active",
      "startDate":       "2025-03-19 15:23:35",
      "successPayments": 1,
      "failPayments":    0,
      "lastPaymentId":   null,
      "lastUpdateDate":  null,
      "parentPaymentId": "2181234567",
      "totalSum":        "50.00"
    },
    {
      "subscriptionId":  5961466,
      "description":     "test_unitpay",
      "status":          "active",
      "startDate":       "2025-03-20 15:13:38",
      "successPayments": 2,
      "failPayments":    0,
      "lastPaymentId":   null,
      "lastUpdateDate":  null,
      "parentPaymentId": "2187654321",
      "totalSum":        "100.00"
    }
  ]
}
```

<table data-header-hidden><thead><tr><th width="192.66664632161456">name</th><th width="114.7777099609375">type</th><th>decription</th></tr></thead><tbody><tr><td><strong>subscriptionId</strong></td><td>число</td><td>ID подписки в системе Unitpay</td></tr><tr><td><strong>description</strong></td><td>строка</td><td>Текстовое описание подписки</td></tr><tr><td><strong>status</strong> </td><td>строка</td><td>Статус подписки: <br><code>new</code> — подписка создана, попыток списания по подписке еще не происходило;<br><code>active</code> — подписка активна;<br><code>close</code> — подписка закрыта.</td></tr><tr><td><strong>startDate</strong> </td><td>строка</td><td>Дата создания подписки в формате YYYY-mm-dd HH:ii:ss (например 2024-10-01 12:32:00)</td></tr><tr><td><strong>successPayments</strong></td><td>число</td><td>Количество успешных платежей по подписке</td></tr><tr><td><strong>failPayments</strong></td><td>число</td><td>Количество не успешных попыток списания по подписке</td></tr><tr><td><strong>lastPaymentId</strong></td><td>число</td><td>ID последнего платежа по подписке</td></tr><tr><td><strong>lastUpdateDate</strong></td><td>строка</td><td>Дата последнего платежа по подписке в формате dd.mm.yyyy hh:ii:ss (например 15.09.2017 19:30:00)</td></tr><tr><td><strong>parentPaymentId</strong></td><td>число</td><td>ID родительского платежа, который инициировал подписку</td></tr><tr><td><strong>totalSum</strong></td><td>число</td><td>Общая сумма, списанная с плательщика по подписке</td></tr><tr><td><strong>closeType</strong></td><td>строка</td><td>Причина закрытия подписки (передается только в случае status=close): <br><code>api</code> — подписка закрыта вами по API;<br><code>error</code> — подписка закрыта в связи с достижением лимита на количество ошибок при попытке списания средств;<br><code>abuse</code> — подписка закрыта в связи с жалобой абонента.</td></tr></tbody></table>

#### Ошибочный ответ

```json
{
    "error": {
        "message": "Описание ошибки"
    }
}
```

<table data-header-hidden><thead><tr><th width="197.888916015625">name</th><th width="108.22212727864581">type</th><th>description</th></tr></thead><tbody><tr><td><strong>message</strong></td><td>строка</td><td>Информация с описанием ошибки</td></tr><tr><td></td><td></td><td></td></tr></tbody></table>

Для получения **списка всех подписок** добавьте параметр

| Name | Type    | Description |
| ---- | ------- | ----------- |
| all  | integer | 1           |

В ответе будет представлен список подписок во всех статусах: new, active, close

{% hint style="warning" %}
Запросы можно выполнить в тестовом режиме. [Узнать подробнее](https://help.unitpay.ru/other/test-api)
{% endhint %}