Получение списка аккаунтов для заказа подписки

Метод используется для получения одностраничного списка аккаунтов, к которым есть доступ у текущего пользователя и которые могут быть использованы для заказа подписки (см. шаг Выбор аккаунта в ). По сравнению с методом Получение списка аккаунтов, используется сокращенный набор данных об аккаунтах, и в ответ не включаются аккаунты в статусе Административная блокировка.

GET {reseller_domain}/internal_api/order_accounts

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название	Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
Content-Type	header	string	Обязательный	Тип данных, передаваемых в запросе. Укажите application/vnd.api+json
Accept	header	string	Обязательный	Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json
X-Api-Locale	header	string	Опциональный	Двухбуквенный код языка данных в ответе
Authorization	header	string	Обязательный	Действующий access token пользователя. Формат: `Bearer <access token>`
reseller_domain	path	string	Обязательный	Доменное имя реселлера
filter[account_type_id]	query	string	Опциональный	Предназначен для фильтрации списка по ID типа аккаунта. Можно указать несколько значений через запятую
filter[name][like]	query	string	Опциональный	Предназначен для фильтрации списка по части названия аккаунта без учета регистра
sort	query	string	Опциональный	Предназначен для сортировки элементов списка по указанному параметру. Доступные значения: sort=created_at — сортировка по возрастанию значений `created_at`. sort=-created_at — сортировка по убыванию значений `created_at`.

Модель ответа

Название				Тип данных	Описание
data				array of objects	Данные ответа
	id			string	ID аккаунта
	type			string	Тип данных
	attributes			object	Информация об аккаунте
		created_at		string	Дата и время создания аккаунта
		name		string	Название аккаунта для отображения в Панели управления Клиента по шаблону типа аккаунта (подробнее см. )
		status		string	Статус аккаунта (см. ). В ответ включаются только аккаунты в следующих статусах: active — Активен. credit_hold — Финансовая блокировка.
		account_type_data		object	Информация о типе аккаунта (см. )
			id	integer	ID типа аккаунта
			key	string	Ключ типа аккаунта
			name	string	Название типа аккаунта
		user_contract		object	Информация о лице, уполномоченном на заключение договора
			last_name	string	Фамилия уполномоченного лица
			first_name	string	Имя уполномоченного лица
			middle_name	string	Отчество уполномоченного лица
			email	string	Email уполномоченного лица
		contact_data		object	Адресная информация аккаунта
			country	string	Код страны
			zip	string	Почтовый индекс
			region	string	Регион (Область)
			city	string	Город
			street	string	Улица
			building	string	Дом
			office	string	Офис
			phone	string	Номер телефона
		custom_attributes		object	Список пар ключ-значение дополнительных атрибутов аккаунта (см. Получение списка атрибутов для создания аккаунта)

Пример запроса

Bash

curl --location --request GET 'https://test.activeplatform.com/internal_api/order_accounts' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample'

Пример ответа

JSON

{
    "data": [
        {
            "id": "1185",
            "type": "order_accounts",
            "attributes": {
                "created_at": "2020-10-05 T09:38:44.590785+0300",
                "name": "First Account",
                "status": "active",
                "account_type_data": {
                    "id": 1562,
                    "key": "personal",
                    "name": "Personal"
                },
                "custom_attributes": {
                    "bank_account": "2300000000000",
                    "invoice": true,
                    "vendor_ccp": ""
                },
                "user_contract": {
                    "last_name": "Frederick",
                    "first_name": "Kunze",
                    "middle_name": "",
                    "email": "Tyra78@example.org"
                },
                "contact_data": {
                    "country": "BY",
                    "zip": "220100",
                    "region": "Minsk",
                    "city": "Minsk",
                    "street": "Main",
                    "building": "",
                    "office": "",
                    "phone": "+375999999999"
                }
            }
        },
        {
            "id": "1680",
            "type": "order_accounts",
            "attributes": {
                "created_at": "2022-01-13 T11:58:49.893191+0300",
                "name": "Second Account",
                "status": "credit_hold",
                "account_type_data": {
                    "id": 2,
                    "key": "business__no_vat",
                    "name": "Business"
                },
                "custom_attributes": {
                    "bank_account": "3200000000000",
                    "invoice": false,
                    "vendor_ccp": ""
                },
                "user_contract": {
                    "last_name": "Dallas",
                    "first_name": "Kenneth",
                    "middle_name": "",
                    "email": "Alexys5@example.net"
                },
                "contact_data": {
                    "country": "BY",
                    "zip": "220021",
                    "region": "Minsk",
                    "city": "Minsk",
                    "street": "Nemiga",
                    "building": "",
                    "office": "",
                    "phone": "+375290000000"
                }
            }
        }
    ]
}