# Получение информации о подписке

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

method                 = getSubscription
params[subscriptionId] = 123456789
params[secretKey]      = ключ

```

#### Обязательные параметры

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

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

```json
{
    "result": {
        "subscriptionId": 123456,
        "description": "Описание подписки",
        "status": "active",
        "startDate": "2017-09-01 09:00:00",
        "successPayments": 4,
        "failPayments": 0,
        "lastPaymentId": 12345678911,
        "lastDateUpdate": "2017-09-15 19:30:00",
        "parentPaymentId": 12345678910,
        "totalSum": 50
    }
}

```

<table data-header-hidden><thead><tr><th width="180.44447835286456">name</th><th width="111.888916015625">type</th><th>description</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 (например 2012-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>Дата последнего платежа по подписке в формате YYYY-mm-dd HH:ii:ss (например 2012-10-01 12:32: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>Причина закрытия подписки (передается только в случае <code>status=close</code>): <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="188.22224934895831">name</th><th width="114.55548095703125">type</th><th>description</th></tr></thead><tbody><tr><td><strong>message</strong></td><td>строка</td><td>Информация с описанием ошибки</td></tr></tbody></table>

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.unitpay.ru/payments/recurring-payments/subscription-info.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.