Unitpay
ru
ru
  • Главная
  • Начало работы
    • Регистрация
    • Добавление проекта
      • Добавление сообщества VK
      • Добавление канала / супергруппы Telegram
    • Модерация проекта
      • Помощник по модерации
    • Перенос проекта
  • Платежи
    • Создание платежа (простой способ)
    • Создание платежа
    • Создание платежа (виджет)
    • Создание ссылок на оплату в личном кабинете
    • Обработчик платежа
    • Информация о платеже
    • Возврат платежа
    • Двухстадийные платежи (платежи с преавторизацией)
    • Подписки API
      • Создание подписки
      • Получение списка активных подписок
      • Получение информации о подписке
      • Закрытие подписки
  • Массовые выплаты
    • Создание выплаты
    • Информация о выплате
    • Информация о карте по BIN
    • Информация о комиссии на выплаты
    • Дополнительно: выплаты на основе CSV-реестра
    • Получение справочника банков-участников СБП (API)
    • Автовыплаты
  • Онлайн-кассы
    • Юнит.Чеки
    • Подключение Онлайн-кассы
    • Параметры для формирования чека
    • Типы позиций для формирования чека
    • Просмотр чека
    • Чек зачета аванса
  • Готовые модули
    • Unitpay SDK
    • Базовый обработчик платежа
    • CMS модули
      • 1C Bitrix
      • Amiro CMS
      • AmoCRM
      • BILLmanager
      • Bitrix24
      • CMS NWICODE
      • CMS-S3
      • CS-Cart
      • DIAFAN.CMS
      • Drupal 8, 9 (commerce)
      • Drupal 7 (ubercart 3)
      • Drupal 7 (commerce)
      • Ecwid от Lightspeed
      • HostCMS
      • InSales
      • Joomshopping 4 (joomla 3)
      • LogicBoxes
      • MODX (miniShop2)
      • Magento
      • Magento 2
      • Netcat CMS
      • OpenCart
      • osCommerce
      • PHPShop
      • Prestashop
      • RetailCRM
      • ReadyScript
      • SellerGames
      • Senler
      • Simpla
      • ShopCMS
      • Tilda
      • Taplink
      • UMI.CMS
      • UCoz
      • VamShop 2
      • Virtuality CMS
      • VirtueMart 3 (joomla 3)
      • Webasyst Shop Script 7 (8)
      • Wix
      • Zen Cart
  • Личный кабинет
    • Telegram бот
    • Инструкция по интерфейсу
      • Регистрация юридических лиц
      • Новый проект и модерация
      • Настройка проекта и прием платежей
      • Подключение стран
      • Выплаты
      • Онлайн-кассы и «Юнит.Чеки»
      • Документы и отчетность
      • Роли и сотрудники
    • Пакет документов для ИП
    • Пакет документов для ООО
    • Смена расчётного счета для выплат
    • Текущий баланс (API)
    • Комиссии проекта (API)
    • Курсы конвертации валют (API)
    • Способы оплаты на проекте (API)
  • Справочник
    • IP адреса системы
    • Коды платежных систем
    • Статусы и ошибки платежей
    • Внешний вид формы оплаты
    • Буквенные коды валют
  • Реферальная программа
    • Интерфейс кабинета реферера (агента)
  • Другие возможности
    • Использование тестового API
    • Получение информации по BIN карты
    • Темная тема
  • Служба поддержки
  • FAQ
    • Как перейти на ИП с физического лица
    • Регистрация юр. лица или ИП
    • Модерация проекта
    • Интеграция платежного решения
    • Прием платежей
    • Возврат платежей
    • Выплаты юр. лицам
    • Массовые выплаты
    • Онлайн-кассы
    • Юридические вопросы
    • Чеки
  • Обновления
Powered by GitBook
On this page

Was this helpful?

  1. Платежи
  2. Подписки API

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

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

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

Path Parameters

Name
Type
Description

subscriptionId

number

ID подписки в системе UnitPay

secretKey

string

Секретный ключ, доступен в настройках проекта

{
   "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
   }
}
{
   "error": {
      "message": "Описание ошибки"
   }
}

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

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

Значение

Описание

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

строка

Дата последнего платежа по подписке в формате YYYY-mm-dd HH:ii:ss (например 2012-10-01 12:32:00)

parentPaymentId

число

ID родительского платежа, который инициировал подписку

totalSum

число

Общая сумма, списанная с плательщика по подписке

closeType

строка

Причина закрытия подписки (передается только в случае status=close): api — подписка закрыта партнером по API error — подписка закрыта в связи с достижением лимита на количество ошибок при попытке списания средств abuse — подписка закрыта в связи с жалобой абонента

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

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

Значение

Описание

message

строка

Информация с описанием ошибки

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

Last updated 4 years ago

Was this helpful?

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

Узнать подробнее