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

GET

GET https://unitpay.ru/api

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

Path Parameters

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

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

{
  "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"
    }
  ]
}

subscriptionId	число	ID подписки в системе Unitpay
description	строка	Текстовое описание подписки
status	строка	Статус подписки: new — подписка создана, попыток списания по подписке еще не происходило; active — подписка активна; close — подписка закрыта.
startDate	строка	Дата создания подписки в формате YYYY-mm-dd HH:ii:ss (например 2024-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	строка	Информация с описанием ошибки

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

Name	Type	Description
all	integer	1

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

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