B2B

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

Песочница
GET https://sandbox.alfabank.ru/api/nfs/jp/v1/products/{productId}
Пром
GET https://baas.alfabank.ru/api/nfs/jp/v1/products/{productId}
Scope

subscriptions

Описание

Метод предназначен для компаний, которые хотят предоставлять своим клиентам – юридическим лицам, информацию о нефинансовых продуктах Альфа-Банка для бизнеса. Он позволяет узнать, в каких подписках клиенту доступен указанный нефинансовый продукт Альфа-Банка, и получить информацию об этих подписках.

Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Accept
stringrequired

application/json

PATH
Атрибут
Описание
productId
stringrequired

Идентификатор продукта. Банк сообщает партнёру API

Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/nfs/jp/v1/products/{productId}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "isAvailable": true,
3  "services": [
4    {
5      "serviceCode": "ALFA_COURSE_PLUS",
6      "priority": 1,
7      "subscriptionName": "Курс+",
8      "subscriptionExtendedState": "ACTIVE",
9      "serviceFee": 99.99,
10      "serviceFeeCurrency": "RUR",
11      "nextFeeAt": "2025-12-14T00:00:00+03:00",
12      "activatedAt": "2025-11-14T00:00:00+03:00",
13      "disabledAt": "2025-12-14T00:00:00+03:00",
14      "servicePageLink": "https://testlink.alfabank.ru/alfa-course",
15      "trialPeriod": {
16        "isTrial": true,
17        "trialMonths": 2
18      }
19    }
20  ]
21}
BODY
атрибут
описание
isAvailable
booleanoptional

Признак доступности продукта в подписках

array of objectsoptional

Список данных о подписках, в которых доступен продукт

serviceCode
stringoptional

Код подписки

priority
integeroptional

Приоритет подписки

subscriptionName
stringoptional

Название подписки

subscriptionExtendedState
stringoptional

Статус подписки. Принимает возможные значения:

  • ACTIVE - активна;
  • DISABLED - отключена;
  • FREE_ACTIVE - активна в бесплатном периоде;
  • PRE_DISABLED - запланировано отключение;
  • FROZEN - заморожена;
  • NONE - отсутствует
serviceFee
numberoptional

Стоимость подписки

serviceFeeCurrency
stringoptional

Код валюты. Принимает возможные значения:

  • RUR - российский рубль
nextFeeAt
stringoptional

Дата следующего платежа в формате ISO 8601

activatedAt
stringoptional

Дата подключения в формате ISO 8601

disabledAt
stringoptional

Дата отключения подписки в формате ISO 8601

servicePageLink
stringoptional

URL основной страницы подписки

objectoptional

Информация о бесплатном периоде

isTrial
booleanoptional

Признак наличия бесплатного периода

trialMonths
integeroptional

Длительность бесплатного периода в месяцах

Пример ответа 200 (OK)
1{
2  "isAvailable": true,
3  "services": [
4    {
5      "serviceCode": "ALFA_COURSE_PLUS",
6      "priority": 1,
7      "subscriptionName": "Курс+",
8      "subscriptionExtendedState": "ACTIVE",
9      "serviceFee": 99.99,
10      "serviceFeeCurrency": "RUR",
11      "nextFeeAt": "2025-12-14T00:00:00+03:00",
12      "activatedAt": "2025-11-14T00:00:00+03:00",
13      "disabledAt": "2025-12-14T00:00:00+03:00",
14      "servicePageLink": "https://testlink.alfabank.ru/alfa-course",
15      "trialPeriod": {
16        "isTrial": true,
17        "trialMonths": 2
18      }
19    }
20  ]
21}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • invalid_request – неверные входные параметры запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 400 (Bad Request)
1{
2  "error": "invalid_request",
3  "error_description": "Authorization header is not present in request headers"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • invalid_token – предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам
error_description
stringoptional

Описание ошибки

Пример ошибки 401 (Unauthorized)
1{
2  "error": "unauthorized",
3  "error_description": "Authorization header is not present in request headers"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • forbidden – доступ к ресурсу запрещён
  • insufficient_scope – недостаточно прав (scope)
error_description
stringoptional

Описание ошибки

Пример ошибки 403 (Forbidden)
1{
2  "error": "forbidden",
3  "error_description": "Access to the requested resource is forbidden"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • not_found – ресурс не найден
error_description
stringoptional

Описание ошибки

Пример ошибки 404 (Not Found)
1{
2  "error": "not_found",
3  "error_description": "Requested resource was not found"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • too_many_requests – превышен лимит запросов
error_description
stringoptional

Описание ошибки

Пример ошибки 429 (Too Many Requests)
1{
2  "error": "too_many_requests",
3  "error_description": "Too many requests, please try again later"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • internal_error – внутренняя ошибка сервиса
error_description
stringoptional

Описание ошибки

Пример ошибки 500 (Internal Server Error)
1{
2  "error": "internal_error",
3  "error_description": "Internal server error occurred"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • service_unavailable – сервис временно недоступен
error_description
stringoptional

Описание ошибки

Пример ошибки 503 (Service Unavailable)
1{
2  "error": "service_unavailable",
3  "error_description": "Service is temporarily unavailable"
4}