# Протокол

## Оглавление

- [keyapis/subscription/v1/keyapis_subscription_subscription_v1.proto](#keyapis_subscription_v1_keyapis_subscription_subscription_v1-proto)
    - [SubscriptionService](#keyapis-subscription-v1-SubscriptionService)
  
    - [GetSubscriptionCountRequest](#keyapis-subscription-v1-GetSubscriptionCountRequest)
    - [GetSubscriptionCountResponse](#keyapis-subscription-v1-GetSubscriptionCountResponse)
    - [GetSubscriptionCountResponse.Error](#keyapis-subscription-v1-GetSubscriptionCountResponse-Error)
    - [GetSubscriptionListRequest](#keyapis-subscription-v1-GetSubscriptionListRequest)
    - [GetSubscriptionListResponse](#keyapis-subscription-v1-GetSubscriptionListResponse)
    - [GetSubscriptionListResponse.Error](#keyapis-subscription-v1-GetSubscriptionListResponse-Error)
    - [GetSubscriptionRequest](#keyapis-subscription-v1-GetSubscriptionRequest)
    - [GetSubscriptionResponse](#keyapis-subscription-v1-GetSubscriptionResponse)
    - [Subscription](#keyapis-subscription-v1-Subscription)
    - [SubscriptionFilter](#keyapis-subscription-v1-SubscriptionFilter)
    - [SubscriptionFilter.ValidationError](#keyapis-subscription-v1-SubscriptionFilter-ValidationError)
    - [SubscriptionFilter.ValidationError.FlatNumbersInvalid](#keyapis-subscription-v1-SubscriptionFilter-ValidationError-FlatNumbersInvalid)
    - [SubscriptionFilter.ValidationError.OrponsInvalid](#keyapis-subscription-v1-SubscriptionFilter-ValidationError-OrponsInvalid)
    - [SubscriptionPaging](#keyapis-subscription-v1-SubscriptionPaging)
    - [SubscriptionPaging.ValidationError](#keyapis-subscription-v1-SubscriptionPaging-ValidationError)
    - [SubscriptionPaging.ValidationError.LimitInvalid](#keyapis-subscription-v1-SubscriptionPaging-ValidationError-LimitInvalid)
    - [SubscriptionPaging.ValidationError.OffsetInvalid](#keyapis-subscription-v1-SubscriptionPaging-ValidationError-OffsetInvalid)
  
    - [Subscription.BillingType](#keyapis-subscription-v1-Subscription-BillingType)
    - [Subscription.StatusType](#keyapis-subscription-v1-Subscription-StatusType)
    - [SubscriptionPaging.DirectionType](#keyapis-subscription-v1-SubscriptionPaging-DirectionType)
    - [SubscriptionPaging.OrderByType](#keyapis-subscription-v1-SubscriptionPaging-OrderByType)
  


## [Схема классов](/svg/protos/key/keyapis/subscription/v1/keyapis_subscription_subscription_v1.proto.svg)
<a href="/svg/protos/key/keyapis/subscription/v1/keyapis_subscription_subscription_v1.proto.svg"><img src="/svg/protos/key/keyapis/subscription/v1/keyapis_subscription_subscription_v1.proto.svg" alt="/svg/protos/key/keyapis/subscription/v1/keyapis_subscription_subscription_v1.proto.svg" style="height:100%;"></a>




<a name="keyapis_subscription_v1_keyapis_subscription_subscription_v1-proto"></a>

## [keyapis/subscription/v1/keyapis_subscription_subscription_v1.proto](/protos/key/keyapis/subscription/v1/keyapis_subscription_subscription_v1.proto)
Сервис реализует функционал управления подписками пользователей.
Подписка это доступный на квартиру набор услуг на перриод времени


<a name="keyapis-subscription-v1-SubscriptionService"></a>

### SubscriptionService
 Сервис подписок

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-subscription-v1-GetSubscription"></a> [GetSubscription](#keyapis-subscription-v1-GetSubscription) | Метод получения подписки. Метод доступен для: admin, mrf, master, ltp_first, service, application(subscription:read или subscription:edit) | [keyapis.subscription.v1.GetSubscriptionRequest](#keyapis-subscription-v1-GetSubscriptionRequest) | [keyapis.subscription.v1.GetSubscriptionResponse](#keyapis-subscription-v1-GetSubscriptionResponse) |
| <a id="keyapis-subscription-v1-GetSubscriptionList"></a> [GetSubscriptionList](#keyapis-subscription-v1-GetSubscriptionList) | Метод получения списка подписок. Метод доступен для: admin, mrf, master, ltp_first, service, application(subscription:read или subscription:edit) | [keyapis.subscription.v1.GetSubscriptionListRequest](#keyapis-subscription-v1-GetSubscriptionListRequest) | [keyapis.subscription.v1.GetSubscriptionListResponse](#keyapis-subscription-v1-GetSubscriptionListResponse) stream |
| <a id="keyapis-subscription-v1-GetSubscriptionCount"></a> [GetSubscriptionCount](#keyapis-subscription-v1-GetSubscriptionCount) | Метод получения количества подписок. Метод доступен для: admin, mrf, master, ltp_first, service, application(subscription:read или subscription:edit) | [keyapis.subscription.v1.GetSubscriptionCountRequest](#keyapis-subscription-v1-GetSubscriptionCountRequest) | [keyapis.subscription.v1.GetSubscriptionCountResponse](#keyapis-subscription-v1-GetSubscriptionCountResponse) |

 <!-- end services -->


<a name="keyapis-subscription-v1-GetSubscriptionCountRequest"></a>


### [GetSubscriptionCountRequest](#keyapis-subscription-v1-GetSubscriptionCountRequest)
 Запрос получения количества подписок


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-GetSubscriptionCountRequest-filter"></a> [filter](#keyapis-subscription-v1-GetSubscriptionCountRequest-filter) | Фильтр |    [keyapis.subscription.v1.SubscriptionFilter](#keyapis-subscription-v1-SubscriptionFilter) | <nil>|






<a name="keyapis-subscription-v1-GetSubscriptionCountResponse"></a>


### [GetSubscriptionCountResponse](#keyapis-subscription-v1-GetSubscriptionCountResponse)
 Ответ на запрос получения количества подписок


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-GetSubscriptionCountResponse-data"></a> [data](#keyapis-subscription-v1-GetSubscriptionCountResponse-data) | Всего подписок |  optional  [int32](#scalar-types) | <nil>|
| <a id="keyapis-subscription-v1-GetSubscriptionCountResponse-error"></a> [error](#keyapis-subscription-v1-GetSubscriptionCountResponse-error) | Ошибка |  optional  [keyapis.subscription.v1.GetSubscriptionCountResponse.Error](#keyapis-subscription-v1-GetSubscriptionCountResponse-Error) | <nil>|






<a name="keyapis-subscription-v1-GetSubscriptionCountResponse-Error"></a>


### [GetSubscriptionCountResponse.Error](#keyapis-subscription-v1-GetSubscriptionCountResponse-Error)
 Ошибка запроса получения количества подписок


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-GetSubscriptionCountResponse-Error-subscription_filter_validation"></a> [subscription_filter_validation](#keyapis-subscription-v1-GetSubscriptionCountResponse-Error-subscription_filter_validation) | Ошибка фильтрации подписок |  optional  [keyapis.subscription.v1.SubscriptionFilter.ValidationError](#keyapis-subscription-v1-SubscriptionFilter-ValidationError) | <nil>|






<a name="keyapis-subscription-v1-GetSubscriptionListRequest"></a>


### [GetSubscriptionListRequest](#keyapis-subscription-v1-GetSubscriptionListRequest)
 Запрос получения списка подписок


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-GetSubscriptionListRequest-filter"></a> [filter](#keyapis-subscription-v1-GetSubscriptionListRequest-filter) | Фильтр |    [keyapis.subscription.v1.SubscriptionFilter](#keyapis-subscription-v1-SubscriptionFilter) | <nil>|
| <a id="keyapis-subscription-v1-GetSubscriptionListRequest-paging"></a> [paging](#keyapis-subscription-v1-GetSubscriptionListRequest-paging) | Пагинация |  optional  [keyapis.subscription.v1.SubscriptionPaging](#keyapis-subscription-v1-SubscriptionPaging) | <nil>|






<a name="keyapis-subscription-v1-GetSubscriptionListResponse"></a>


### [GetSubscriptionListResponse](#keyapis-subscription-v1-GetSubscriptionListResponse)
 Ответ на запрос получения списка подписок


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-GetSubscriptionListResponse-data"></a> [data](#keyapis-subscription-v1-GetSubscriptionListResponse-data) | Подписка |  optional  [keyapis.subscription.v1.Subscription](#keyapis-subscription-v1-Subscription) | <nil>|
| <a id="keyapis-subscription-v1-GetSubscriptionListResponse-error"></a> [error](#keyapis-subscription-v1-GetSubscriptionListResponse-error) | Ошибка |  optional  [keyapis.subscription.v1.GetSubscriptionListResponse.Error](#keyapis-subscription-v1-GetSubscriptionListResponse-Error) | <nil>|






<a name="keyapis-subscription-v1-GetSubscriptionListResponse-Error"></a>


### [GetSubscriptionListResponse.Error](#keyapis-subscription-v1-GetSubscriptionListResponse-Error)
 Ошибка запроса получения списка подписки


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-GetSubscriptionListResponse-Error-subscription_filter_validation"></a> [subscription_filter_validation](#keyapis-subscription-v1-GetSubscriptionListResponse-Error-subscription_filter_validation) | Ошибка фильтрации |  optional  [keyapis.subscription.v1.SubscriptionFilter.ValidationError](#keyapis-subscription-v1-SubscriptionFilter-ValidationError) | <nil>|
| <a id="keyapis-subscription-v1-GetSubscriptionListResponse-Error-subscription_paging_validation"></a> [subscription_paging_validation](#keyapis-subscription-v1-GetSubscriptionListResponse-Error-subscription_paging_validation) | Ошибка пагинации по страницам |  optional  [keyapis.subscription.v1.SubscriptionPaging.ValidationError](#keyapis-subscription-v1-SubscriptionPaging-ValidationError) | <nil>|






<a name="keyapis-subscription-v1-GetSubscriptionRequest"></a>


### [GetSubscriptionRequest](#keyapis-subscription-v1-GetSubscriptionRequest)
 Запрос получения подписки


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-GetSubscriptionRequest-id"></a> [id](#keyapis-subscription-v1-GetSubscriptionRequest-id) | Идентификатор подписки |    [string](#scalar-types) | REQUIRED|






<a name="keyapis-subscription-v1-GetSubscriptionResponse"></a>


### [GetSubscriptionResponse](#keyapis-subscription-v1-GetSubscriptionResponse)
 Ответ на запрос получения подписки


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-GetSubscriptionResponse-data"></a> [data](#keyapis-subscription-v1-GetSubscriptionResponse-data) | Подписка |  optional  [keyapis.subscription.v1.Subscription](#keyapis-subscription-v1-Subscription) | <nil>|






<a name="keyapis-subscription-v1-Subscription"></a>


### [Subscription](#keyapis-subscription-v1-Subscription)
 Подписка


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-Subscription-id"></a> [id](#keyapis-subscription-v1-Subscription-id) | Идентификатор. Может быть явно задан при создании. Тип: Guid |    [string](#scalar-types) | <nil>|
| <a id="keyapis-subscription-v1-Subscription-orpon"></a> [orpon](#keyapis-subscription-v1-Subscription-orpon) | ОРПОН. Идентификатор дома |    [int64](#scalar-types) | REQUIRED|
| <a id="keyapis-subscription-v1-Subscription-flat_number"></a> [flat_number](#keyapis-subscription-v1-Subscription-flat_number) | Номер квартиры |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-subscription-v1-Subscription-offer_id"></a> [offer_id](#keyapis-subscription-v1-Subscription-offer_id) | Идентификатор коммерческой возможности(КВ). Заполняется сервером на основе идентификатора из технологического плана(ТП) |    [int32](#scalar-types) | OUTPUT_ONLY|
| <a id="keyapis-subscription-v1-Subscription-status_type"></a> [status_type](#keyapis-subscription-v1-Subscription-status_type) | Cтатус подписки. При создании может быть: SETUP, ACTIVE |    [keyapis.subscription.v1.Subscription.StatusType](#keyapis-subscription-v1-Subscription-StatusType) | REQUIRED|
| <a id="keyapis-subscription-v1-Subscription-previous_status_type"></a> [previous_status_type](#keyapis-subscription-v1-Subscription-previous_status_type) | Предыдущий статус подписки. В справочник входят только финальные статусы. Заполняется сервером при изменении статусов |    [keyapis.subscription.v1.Subscription.StatusType](#keyapis-subscription-v1-Subscription-StatusType) | OUTPUT_ONLY|
| <a id="keyapis-subscription-v1-Subscription-price"></a> [price](#keyapis-subscription-v1-Subscription-price) | Цена |    [google.protobuf.DoubleValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-subscription-v1-Subscription-created_at"></a> [created_at](#keyapis-subscription-v1-Subscription-created_at) | Дата создания записи. Заполняется сервером |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-subscription-v1-Subscription-changed_at"></a> [changed_at](#keyapis-subscription-v1-Subscription-changed_at) | Дата последнего изменения. Заполняется и обновляется сервером. Заполняется при создании и изменении. Является версией объекта |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-subscription-v1-Subscription-is_enable_auto_subscribe"></a> [is_enable_auto_subscribe](#keyapis-subscription-v1-Subscription-is_enable_auto_subscribe) | Признак для определения автоподписок. Редактировать флаг запрещено. Проставляется сервером в true при создании через задачу на автоподписку |    [bool](#scalar-types) | OUTPUT_ONLY|
| <a id="keyapis-subscription-v1-Subscription-billing_type"></a> [billing_type](#keyapis-subscription-v1-Subscription-billing_type) | Тип биллинга |    [keyapis.subscription.v1.Subscription.BillingType](#keyapis-subscription-v1-Subscription-BillingType) | <nil>|
| <a id="keyapis-subscription-v1-Subscription-expired_at"></a> [expired_at](#keyapis-subscription-v1-Subscription-expired_at) | Срок действия. Проставляется при создании |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-subscription-v1-Subscription-parent_id"></a> [parent_id](#keyapis-subscription-v1-Subscription-parent_id) | Идентификатор подписки, в зависимости от которой подключена данная. Заполняется в подписках на опции. Тип: Guid |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-subscription-v1-Subscription-account"></a> [account](#keyapis-subscription-v1-Subscription-account) | Аккаунт |    [google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-subscription-v1-Subscription-offer"></a> [offer](#keyapis-subscription-v1-Subscription-offer) | Снапшот состояния коммерческой возможности на момент создания подписки. В данный момент это ссылка в базе на запись, в будущем это будет снапшот |    [keyapis.subscription.v1.Offer](#keyapis-subscription-v1-Offer) | <nil>|
| <a id="keyapis-subscription-v1-Subscription-discount_price"></a> [discount_price](#keyapis-subscription-v1-Subscription-discount_price) | Цена по скидки. Заполнена если оплата подписки прошла по скидке, иначе очищается |    [google.protobuf.DoubleValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|






<a name="keyapis-subscription-v1-SubscriptionFilter"></a>


### [SubscriptionFilter](#keyapis-subscription-v1-SubscriptionFilter)
 Фильтр подписок


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-SubscriptionFilter-orpons"></a> [orpons](#keyapis-subscription-v1-SubscriptionFilter-orpons) | По ОРПОНам |  repeated  [int64](#scalar-types) | <nil>|
| <a id="keyapis-subscription-v1-SubscriptionFilter-flat_numbers"></a> [flat_numbers](#keyapis-subscription-v1-SubscriptionFilter-flat_numbers) | По номерам квартир |  repeated  [string](#scalar-types) | <nil>|






<a name="keyapis-subscription-v1-SubscriptionFilter-ValidationError"></a>


### [SubscriptionFilter.ValidationError](#keyapis-subscription-v1-SubscriptionFilter-ValidationError)
 Ошибки валидации фильтра по подпискам.
Эти проверки выполняются до обращения в базу данных


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-SubscriptionFilter-ValidationError-orpons"></a> [orpons](#keyapis-subscription-v1-SubscriptionFilter-ValidationError-orpons) | Формат ОРПОН некорректен |  optional  [keyapis.subscription.v1.SubscriptionFilter.ValidationError.OrponsInvalid](#keyapis-subscription-v1-SubscriptionFilter-ValidationError-OrponsInvalid) | <nil>|
| <a id="keyapis-subscription-v1-SubscriptionFilter-ValidationError-flat_numbers"></a> [flat_numbers](#keyapis-subscription-v1-SubscriptionFilter-ValidationError-flat_numbers) | Формат квартиры некорректен |  optional  [keyapis.subscription.v1.SubscriptionFilter.ValidationError.FlatNumbersInvalid](#keyapis-subscription-v1-SubscriptionFilter-ValidationError-FlatNumbersInvalid) | <nil>|






<a name="keyapis-subscription-v1-SubscriptionFilter-ValidationError-FlatNumbersInvalid"></a>


### [SubscriptionFilter.ValidationError.FlatNumbersInvalid](#keyapis-subscription-v1-SubscriptionFilter-ValidationError-FlatNumbersInvalid)
 Причины:
- Формат квартиры некорректен (например, длина номера квартира более 4 знаков или отрицательное значение)






<a name="keyapis-subscription-v1-SubscriptionFilter-ValidationError-OrponsInvalid"></a>


### [SubscriptionFilter.ValidationError.OrponsInvalid](#keyapis-subscription-v1-SubscriptionFilter-ValidationError-OrponsInvalid)
 Причины:
- Формат ОРПОН некорректен;
- ОРПОН передан некорректно, к примеру, значение <= 1






<a name="keyapis-subscription-v1-SubscriptionPaging"></a>


### [SubscriptionPaging](#keyapis-subscription-v1-SubscriptionPaging)
 Пагинация по подпискам


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-SubscriptionPaging-order_by_type"></a> [order_by_type](#keyapis-subscription-v1-SubscriptionPaging-order_by_type) | Тип значения сортировки. По умолчанию: ID |    [keyapis.subscription.v1.SubscriptionPaging.OrderByType](#keyapis-subscription-v1-SubscriptionPaging-OrderByType) | <nil>|
| <a id="keyapis-subscription-v1-SubscriptionPaging-direction_type"></a> [direction_type](#keyapis-subscription-v1-SubscriptionPaging-direction_type) | Тип направления сортировки. По умолчанию: DESC |    [keyapis.subscription.v1.SubscriptionPaging.DirectionType](#keyapis-subscription-v1-SubscriptionPaging-DirectionType) | <nil>|
| <a id="keyapis-subscription-v1-SubscriptionPaging-limit"></a> [limit](#keyapis-subscription-v1-SubscriptionPaging-limit) | Количество записей на страницу. Минимальное значение: 1. Максимальное значение: 100. По умолчанию: 20. Если значение 0 (не передано), то выставляем значение по умолчанию |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-subscription-v1-SubscriptionPaging-offset"></a> [offset](#keyapis-subscription-v1-SubscriptionPaging-offset) | Сдвиг. По умолчанию: 0 |    [int32](#scalar-types) | <nil>|






<a name="keyapis-subscription-v1-SubscriptionPaging-ValidationError"></a>


### [SubscriptionPaging.ValidationError](#keyapis-subscription-v1-SubscriptionPaging-ValidationError)
 Ошибка валидации постраничной пагинации по подпискам.
Эти проверки выполняются до обращения в базу данных


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-subscription-v1-SubscriptionPaging-ValidationError-limit"></a> [limit](#keyapis-subscription-v1-SubscriptionPaging-ValidationError-limit) | Количество передано некорректно |  optional  [keyapis.subscription.v1.SubscriptionPaging.ValidationError.LimitInvalid](#keyapis-subscription-v1-SubscriptionPaging-ValidationError-LimitInvalid) | <nil>|
| <a id="keyapis-subscription-v1-SubscriptionPaging-ValidationError-offset"></a> [offset](#keyapis-subscription-v1-SubscriptionPaging-ValidationError-offset) | Сдвиг передан некорректно |  optional  [keyapis.subscription.v1.SubscriptionPaging.ValidationError.OffsetInvalid](#keyapis-subscription-v1-SubscriptionPaging-ValidationError-OffsetInvalid) | <nil>|






<a name="keyapis-subscription-v1-SubscriptionPaging-ValidationError-LimitInvalid"></a>


### [SubscriptionPaging.ValidationError.LimitInvalid](#keyapis-subscription-v1-SubscriptionPaging-ValidationError-LimitInvalid)
 Причины:
- Значение количества < 0 или > 100






<a name="keyapis-subscription-v1-SubscriptionPaging-ValidationError-OffsetInvalid"></a>


### [SubscriptionPaging.ValidationError.OffsetInvalid](#keyapis-subscription-v1-SubscriptionPaging-ValidationError-OffsetInvalid)
 Причины:
- Значение сдвига < 0





 <!-- end messages -->



<a name="keyapis-subscription-v1-Subscription-BillingType"></a>

### [Subscription.BillingType](#keyapis-subscription-v1-Subscription-BillingType)
 Типы биллинга подпискии

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-subscription-v1-Subscription-BillingType-BILLING_TYPE_UNKNOWN"></a> [BILLING_TYPE_UNKNOWN](#keyapis-subscription-v1-Subscription-BillingType-BILLING_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-subscription-v1-Subscription-BillingType-ASR_MRF"></a> [ASR_MRF](#keyapis-subscription-v1-Subscription-BillingType-ASR_MRF) | АСР МРФ. Обслуживание счетов и расчёты с клиентами происходят в АСР МРФ |
| 2 | <a id="keyapis-subscription-v1-Subscription-BillingType-ASR_KEY"></a> [ASR_KEY](#keyapis-subscription-v1-Subscription-BillingType-ASR_KEY) | АСР Ключ. Обслуживание счетов и расчёты с клиентами происходят внутри Ключа |
| 3 | <a id="keyapis-subscription-v1-Subscription-BillingType-ASR_MC"></a> [ASR_MC](#keyapis-subscription-v1-Subscription-BillingType-ASR_MC) | АСР УК. Обслуживание счетов и расчёты с клиентами происходят во внешнем АСР от управляющей компании |




<a name="keyapis-subscription-v1-Subscription-StatusType"></a>

### [Subscription.StatusType](#keyapis-subscription-v1-Subscription-StatusType)
 Типы статусов подписки

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-subscription-v1-Subscription-StatusType-STATUS_TYPE_UNKNOWN"></a> [STATUS_TYPE_UNKNOWN](#keyapis-subscription-v1-Subscription-StatusType-STATUS_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-subscription-v1-Subscription-StatusType-SETUP"></a> [SETUP](#keyapis-subscription-v1-Subscription-StatusType-SETUP) | Настроена. Подписка переведена в статус настройки. Это промо-период, либо монтажник проверяет работу оборудования. Услуги подписки не оплачены, но доступны для использования. Финальный статус |
| 2 | <a id="keyapis-subscription-v1-Subscription-StatusType-ACTIVE"></a> [ACTIVE](#keyapis-subscription-v1-Subscription-StatusType-ACTIVE) | Активна. Подписка активирована. С этого момента считаем что нужно считать денежки. Услуги подписки оплачены и доступны для использования. Финальный статус |
| 3 | <a id="keyapis-subscription-v1-Subscription-StatusType-BLOCKED"></a> [BLOCKED](#keyapis-subscription-v1-Subscription-StatusType-BLOCKED) | Заблокирована. Подписка фин. заблокирована. Подписка в фин. блокировке. Услуги подписки не оплачены и не доступны. Финальный статус |
| 4 | <a id="keyapis-subscription-v1-Subscription-StatusType-CANCELED"></a> [CANCELED](#keyapis-subscription-v1-Subscription-StatusType-CANCELED) | Отменена. Подписка отменена. Пользователь отменил подписку. Услуги подписки больше не существуют и не доступны абоненту |
| 5 | <a id="keyapis-subscription-v1-Subscription-StatusType-SCHEDULED_CANCELED"></a> [SCHEDULED_CANCELED](#keyapis-subscription-v1-Subscription-StatusType-SCHEDULED_CANCELED) | Запланированная отмена. Пользователь решил отказаться от услуги, но уже заплатил. Подписка запланирована к отмене, будет действовать до истечения срока действия в подписке. Услуги подписки оплачены и доступны для использования. Финальный статус |




<a name="keyapis-subscription-v1-SubscriptionPaging-DirectionType"></a>

### [SubscriptionPaging.DirectionType](#keyapis-subscription-v1-SubscriptionPaging-DirectionType)
 Справочник типов направлений сортировки

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-subscription-v1-SubscriptionPaging-DirectionType-DIRECTION_TYPE_UNKNOWN"></a> [DIRECTION_TYPE_UNKNOWN](#keyapis-subscription-v1-SubscriptionPaging-DirectionType-DIRECTION_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-subscription-v1-SubscriptionPaging-DirectionType-DESC"></a> [DESC](#keyapis-subscription-v1-SubscriptionPaging-DirectionType-DESC) | От большего к меньшему |
| 2 | <a id="keyapis-subscription-v1-SubscriptionPaging-DirectionType-ASC"></a> [ASC](#keyapis-subscription-v1-SubscriptionPaging-DirectionType-ASC) | От меньшего к большему |




<a name="keyapis-subscription-v1-SubscriptionPaging-OrderByType"></a>

### [SubscriptionPaging.OrderByType](#keyapis-subscription-v1-SubscriptionPaging-OrderByType)
 Справочник типов значений сортировки

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-subscription-v1-SubscriptionPaging-OrderByType-ORDER_BY_TYPE_UNKNOWN"></a> [ORDER_BY_TYPE_UNKNOWN](#keyapis-subscription-v1-SubscriptionPaging-OrderByType-ORDER_BY_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-subscription-v1-SubscriptionPaging-OrderByType-ID"></a> [ID](#keyapis-subscription-v1-SubscriptionPaging-OrderByType-ID) | По идентификатору |


 <!-- end enums -->

 <!-- end HasExtensions -->



## Скалярные типы значений
<a id="scalar-types"></a>

| .proto Type | Примечание | Python | Go | Ruby | C# | C++ | Java | PHP |
| ----------- | ---------- | ------ | -- | ---- | -- | --- | ---- | --- |
| [double](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | float | float64 | Float | double | double | double | float |
| [float](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | float | float32 | Float | float | float | float | float |
| [int32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [int64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [uint32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| [uint64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint64 | Bignum or Fixnum (as required) | ulong | uint64 | long | integer/string |
| [sint32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [sint64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [fixed32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | int | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| [fixed64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | int/long | uint64 | Bignum | ulong | uint64 | long | integer/string |
| [sfixed32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always four bytes. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [sfixed64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always eight bytes. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [bool](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | boolean | bool | TrueClass/FalseClass | bool | bool | boolean | boolean |
| [string](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | A string must always contain UTF-8 encoded or 7-bit ASCII text. | str/unicode | string | String (UTF-8) | string | string | String | string |
| [bytes](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | May contain any arbitrary sequence of bytes. | str | []byte | String (ASCII-8BIT) | ByteString | string | ByteString | string |