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

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

GET https://unitpay.ru/api?method=listSubscriptions&params[projectId]=1&params[secretKey]=ключ

Path Parameters

Name	Type	Description
projectId	integer	ID вашего проекта в системе UnitPay
secretKey	string	Секретный ключ, доступен в настройках проекта

200

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

{"result": 
    [
        "subscriptionId": 123456,
        "description": "Описание подписки",
        "status": "active",
        "startDate": "2017-09-01 09:00:00",
        "successPayments": 4,
        "failPayments": 0,
        "lastPaymentId": 12345678911,
        "lastUpdateDate": "15.09.2017 19:30:00",
        "parentPaymentId": 12345678910,
        "totalSum": 50.00 
    ],
    [
        "subscriptionId": 123457,
        "description": "Описание подписки",
        "status": "active",
        "startDate": "2017-09-02 09:00:00",
        "successPayments": 0,
        "failPayments": 2,
        "lastPaymentId": null,
        "lastUpdateDate": "15.09.2017 19:30:00",
        "parentPaymentId": 12345678912,
        "totalSum": 0.00 
    ]
}

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

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

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

{"result": 
    [
        "subscriptionId": 123456,
        "description": "Описание подписки",
        "status": "active",
        "startDate": "2017-09-01 09:00:00",
        "successPayments": 4,
        "failPayments": 0,
        "lastPaymentId": 12345678911,
        "lastUpdateDate": "15.09.2017 19:30:00",
        "parentPaymentId": 12345678910,
        "totalSum": 50.00 
    ],
    [
        "subscriptionId": 123457,
        "description": "Описание подписки",
        "status": "active",
        "startDate": "2017-09-02 09:00:00",
        "successPayments": 0,
        "failPayments": 2,
        "lastPaymentId": null,
        "lastUpdateDate": "15.09.2017 19:30:00",
        "parentPaymentId": 12345678912,
        "totalSum": 0.00 
    ]
}

	Значение	Описание
subscriptionId	число	ID подписки в системе Unitpay
description	строка	Текстовое описание подписки
status	строка	Статус подписки: new — подписка создана, попыток списания по подписке еще не происходило active — подписка активна close — подписка закрыта
startDate	строка	Дата создания подписки в формате YYYY-mm-dd HH:ii:ss (например 2012-10-01 12:32:00)
successPayments	число	Количество успешных платежей по подписке
failPayments	число	Количество не успешных попыток списания по подписке
lastPaymentId	число	ID последнего платежа по подписке
lastUpdateDate	строка	Дата последнего платежа по подписке в формате dd.mm.YYYY HH:ii:ss (например 15.09.2017 19:30:00)
parentPaymentId	число	ID родительского платежа, который инициировал подписку
totalSum	число	Общая сумма, списанная с плательщика по подписке
closeType	строка	Причина закрытия подписки (передается только в случае status=close): api — подписка закрыта партнером по API error — подписка закрыта в связи с достижением лимита на количество ошибок при попытке списания средств abuse — подписка закрыта в связи с жалобой абонента

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

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

	Значение	Описание
message	строка	Информация с описанием ошибки

Запрос можно выполнить в тестовом режиме. Узнать подробнее