Subscription — управление подписками абонента

Группа методов subscription внешнего программного интерфейса Менеджера сервиса предназначена для управления подписками абонента.

Для управления подписками обслуживаемых абонентов необходимо использовать методы группы account/customer_subscriptions .

Сводка по методам

Метод	Назначение
subscription/extend	Создать расширяющую подписку
subscription/info	Информация о подписке
subscription/list	Cписок подписок
subscription/prolong	Создать продлевающую подписку

subscription/extend

Создать расширяющую подписку

Параметр	Тип	Описание	Пример
Запрос
account	Число (+12.0)	Код абонента	1010
id	Строка переменная (9)	Номер основной подписки	000000001
Ответ: id (1)
Нет параметров

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/subscription/extend
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1010,
  "id": "000000001",
  "auth": {
    "account": 1010
  }
}

Пример ответа Развернуть

{
  "id": "000000002",
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

subscription/info

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

Параметр	Тип	Описание	Пример
Запрос
id	Строка переменная (9)	Номер подписки	000000001
Ответ: subscription (1)
id	Строка переменная (9)	Номер подписки	000000001
created	Дата и время в строке формата ISO	Дата оформления подписки	28.02.2019 10:00:00
updated *	Дата и время в строке формата ISO	Дата изменения подписки	28.02.2019 10:00:00
start	Дата и время в строке формата ISO	Начало действия	20.09.2024 0:00:00
completion	Дата и время в строке формата ISO	Завершение действия	19.09.2025 23:59:59
account	Число (+12.0)	Код обслуживаемого абонента	1010
servant *	Число (+12.0)	Код ведущего абонента	1000
servant_tariff *	Строка переменная (9)	Код тарифа обслуживающей организации	SERV00001
tariff	Строка переменная (9)	Код тарифа	PROV00001
period *	Строка переменная (10)	Код периода действия	1YR
parent *	Строка переменная (9)	Номер основной подписки
type	Строка (перечисление)	Тип подписки: basic (Основная) extending (Расширяющая) prolonging (Продлевающая)	basic
amount	Число (+10.0)	Количество	1
bill *	Строка переменная (9)	Номер счета на оплату	000000001
bill_id *	Строка переменная (36)	Идентификатор счета на оплату	00000000-0000-0000-0000-000000000000
services	Список (0..*)	Услуги
- id	Строка переменная (9)	Код услуги	000000001
- name	Строка переменная (100)	Наименование услуги	Количество прав пользователей на запуск приложений
- service_id	Строка переменная (50)	Идентификатор услуги	КоличествоПравПользователейНаЗапускПриложений
- provider_name	Строка переменная (150)	Наименование поставщика услуги	Менеджер сервиса
- provider_id	Строка переменная (50)	Идентификатор поставщика услуги	sm
- description *	Строка неограниченной длины	Описание
- type	Строка (перечисление)	Тип услуги: limited (Лимитированная) unique (Уникальная) unlimited (Безлимитная)	limited
- activation_status *	Строка (перечисление)	Состояние активации: activated (Активирована) error (Ошибка при активации) in_process (В процессе активации)	activated
- amount	Число (+10.0)	Количество лицензий	1
- start_date *	Дата и время в строке формата ISO	Дата подключения	01.01.2020 0:00:00
- end_date *	Дата и время в строке формата ISO	Дата отключения	28.02.2020 0:00:00

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/subscription/info
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": "000000001",
  "auth": {
    "account": 1010
  }
}

Пример ответа Развернуть

{
  "subscription": {
    "id": "000000001",
    "created": "2019-02-28T10:00:00",
    "updated": "2019-02-28T10:00:00",
    "start": "2024-09-20T00:00:00",
    "completion": "2025-09-19T23:59:59",
    "account": 1010,
    "servant": 1000,
    "servant_tariff": "SERV00001",
    "tariff": "PROV00001",
    "period": "1YR",
    "parent": "",
    "type": "basic",
    "amount": 1,
    "bill": "000000001",
    "bill_id": "00000000-0000-0000-0000-000000000000",
    "services": [
      {
        "id": "000000001",
        "name": "Количество прав пользователей на запуск приложений",
        "service_id": "КоличествоПравПользователейНаЗапускПриложений",
        "provider_name": "Менеджер сервиса",
        "provider_id": "sm",
        "description": "",
        "type": "limited",
        "activation_status": "activated",
        "amount": 1,
        "start_date": "2020-01-01T00:00:00",
        "end_date": "2020-02-28T00:00:00"
      }
    ]
  },
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

subscription/list

Cписок подписок

Параметр	Тип	Описание	Пример
Запрос
scope *	Массив из Строка (перечисление)	Параметры получения данных: services (Включать услуги)	["services"]
start_date *	Дата и время в строке формата ISO	Дата создания подписки. Начальная, для отбора по периоду	01.01.2020 0:00:00
end_date *	Дата и время в строке формата ISO	Дата создания подписки. Конечная, для отбора по периоду	28.02.2020 0:00:00
active *	Булево	Получение только активных подписок	true
basic *	Булево	Получение только основных подписок	false
account *	Число (+12.0)	Код обслуживаемого абонента	1010
Ответ: subscription (0..*)
id	Строка переменная (9)	Номер подписки	000000001
created	Дата и время в строке формата ISO	Дата оформления подписки	28.02.2019 10:00:00
updated *	Дата и время в строке формата ISO	Дата изменения подписки	28.02.2019 10:00:00
start	Дата и время в строке формата ISO	Начало действия	20.09.2024 0:00:00
completion	Дата и время в строке формата ISO	Завершение действия	19.09.2025 23:59:59
account	Число (+12.0)	Код обслуживаемого абонента	1010
servant *	Число (+12.0)	Код ведущего абонента	1000
servant_tariff *	Строка переменная (9)	Код тарифа обслуживающей организации	SERV00001
tariff	Строка переменная (9)	Код тарифа	PROV00001
period *	Строка переменная (10)	Код периода действия	1YR
parent *	Строка переменная (9)	Номер основной подписки
type	Строка (перечисление)	Тип подписки: basic (Основная) extending (Расширяющая) prolonging (Продлевающая)	basic
amount	Число (+10.0)	Количество	1
bill *	Строка переменная (9)	Номер счета на оплату	000000001
bill_id *	Строка переменная (36)	Идентификатор счета на оплату	00000000-0000-0000-0000-000000000000
services	Список (0..*)	Услуги
- id	Строка переменная (9)	Код услуги	000000001
- name	Строка переменная (100)	Наименование услуги	Количество прав пользователей на запуск приложений
- service_id	Строка переменная (50)	Идентификатор услуги	КоличествоПравПользователейНаЗапускПриложений
- provider_name	Строка переменная (150)	Наименование поставщика услуги	Менеджер сервиса
- provider_id	Строка переменная (50)	Идентификатор поставщика услуги	sm
- description *	Строка неограниченной длины	Описание
- type	Строка (перечисление)	Тип услуги: limited (Лимитированная) unique (Уникальная) unlimited (Безлимитная)	limited
- activation_status *	Строка (перечисление)	Состояние активации: activated (Активирована) error (Ошибка при активации) in_process (В процессе активации)	activated
- amount	Число (+10.0)	Количество лицензий	1
- start_date *	Дата и время в строке формата ISO	Дата подключения	01.01.2020 0:00:00
- end_date *	Дата и время в строке формата ISO	Дата отключения	28.02.2020 0:00:00

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/subscription/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "auth": {
    "account": 1010
  }
}

Пример ответа Развернуть

{
  "subscription": [
    {
      "id": "000000001",
      "created": "2019-02-28T10:00:00",
      "updated": "2019-02-28T10:00:00",
      "start": "2024-09-20T00:00:00",
      "completion": "2025-09-19T23:59:59",
      "account": 1010,
      "servant": 1000,
      "servant_tariff": "SERV00001",
      "tariff": "PROV00001",
      "period": "1YR",
      "parent": "",
      "type": "basic",
      "amount": 1,
      "bill": "000000001",
      "bill_id": "00000000-0000-0000-0000-000000000000",
      "services": [
        {
          "id": "000000001",
          "name": "Количество прав пользователей на запуск приложений",
          "service_id": "КоличествоПравПользователейНаЗапускПриложений",
          "provider_name": "Менеджер сервиса",
          "provider_id": "sm",
          "description": "",
          "type": "limited",
          "activation_status": "activated",
          "amount": 1,
          "start_date": "2020-01-01T00:00:00",
          "end_date": "2020-02-28T00:00:00"
        }
      ]
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

subscription/prolong

Создать продлевающую подписку

Параметр	Тип	Описание	Пример
Запрос
account	Число (+12.0)	Код абонента	1010
id	Строка переменная (9)	Номер основной подписки	000000001
Ответ: id (1)
Нет параметров

Пример запроса Развернуть

POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/subscription/prolong
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "account": 1010,
  "id": "000000001",
  "auth": {
    "account": 1010
  }
}

Пример ответа Развернуть

{
  "id": "000000002",
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх