С чего начать

Содержание

Сценарий интеграции
Как это работает
Сценарий пользователя
Глоссарий
Статусы подписок

Сценарий интеграции

Чтобы подключить Подписки:

Как это работает

Шаг 1 — получение токена для открытия платежного интерфейса

Шаг 2 — совершение покупки

Шаг 3 — совершение оплаты

Сценарий пользователя

Глоссарий

План подписки

Условия оплаты (сумма, валюта, периодичность), на основе которых пользователь приобретает доступ к услуге. Настройка плана — обязательный этап интеграции.

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

Услуга или пакет услуг, предоставляемые пользователю по подписке. Для создания продукта используется метод API Создание продукта. Создание продуктов необходимо, если вы настраиваете продажу отдельных подписок на разные услуги или хотите дать пользователю возможность оформлять несколько подписок одновременно. Пример продукта подписки — доступ к каналу стримера, к игре или к уникальному предмету/уникальной способности. Подробнее о настройке и использовании продуктов вы можете прочитать в инструкции.

Сочетание продукта и выбранного плана. Подписка создается, когда пользователь выбирает план подписки и получает доступ к услуге. Количество созданных подписок, которые пользователь может оформить одновременно, зависит от количества продуктов в проекте. Условия подписки (расчетный период, стоимость и другие) соответствуют условиям выбранного плана. Если условия плана изменяются после создания подписки, условия существующей подписки не меняются.

ПРИМЕР 1

Продукт: Доступ к игре

План подписки Silver: $10 за 1 месяц
План подписки Gold: $100 за 1 год

Пользователь может выбрать один из вариантов подписки:

Подписка 1: Доступ к игре за $10 в месяц
Подписка 2: Доступ к игре за $100 в год

ПРИМЕР 2

Продукт 1: Доступ к игре1

Продукт 2: Доступ к игре2

План подписки: $10 за 1 месяц

Пользователь может одновременно оформить две подписки:

Подписка 1: Доступ к игре1 за $10 в месяц
Подписка 2: Доступ к игре2 за $10 в месяц

Если продукт подписки не настроен, пользователь может оформить только одну подписку одновременно. Чтобы у пользователя появилась возможность оформить несколько подписок одновременно, необходимо настроить продукты.

Группа планов

Набор планов, которые имеют одинаковое значение параметра group_id. Чтобы создать или изменить группу, передайте параметр group_id в методы:

Создание группы планов необходимо, если вы хотите:

создать продукт подписки;
ограничить количество планов, которые можно выбрать для подписки на продукт;
дать возможность пользователю перейти на другой план внутри группы.

Подробнее о настройке и использовании групп вы можете прочитать в инструкции.

Пробный (триальный) период

Период, в течение которого пользователь может опробовать подписку, не оплачивая ее. Особенности:

При покупке подписки с пробным периодом создается платежный аккаунт и выполняется авторизационный платеж — со счета клиента списывается небольшая сумма, после чего происходит возврат средств. При списании платежа вебхук о совершенном платеже не отправляется на указанный URL.
После окончания пробного периода списывается полная стоимость плана подписки, при этом на указанный URL отправляются вебхук о платеже и продлении подписки или об отмене, если оплата подписки не удалась. Пробный период не входит в период действия плана и его длительность считается отдельно.

Пробный период может быть добавлен в качестве бонуса в промоакцию.

Льготный (грейс) период

Период отсрочки платежа по подписке. В течение этого периода пользователи, не оплатившие вовремя подписку, могут продолжать пользоваться услугами. Особенности:

Льготный период предусмотрен только для подписок с единоразовым платежом. Для автопродлеваемых подписок средства списываются автоматически.
Длительность льготного периода можно изменять в настройках плана подписки в Личном Кабинете Иксолла. Система уведомляет пользователя о необходимости произвести оплату в момент активации льготного периода и каждый последующий день действия льготного периода.
При оплате пользователем подписки во время действия льготного периода, оплата производится за полный платежный период. Количество дней, которое пользователь находился в льготном периоде, вычитается из общего числа доступных пользователю дней, так как они считаются использованными.
Если в настройке плана в поле Льготный период установлено значение 0, такой план не имеет льготного периода.

Период попыток списания (ретрай период)

Период, в течение которого совершаются попытки списания средств с сохраненного платежного аккаунта. Настраивается только для подписок с автоматическим типом продления и активируется при неудачном автоматическом списании. Особенности:

Попытки списания средств осуществляются с сохраненного платежного аккаунта раз в сутки.
Попытки списания продолжаются до тех пор, пока подписка не будет продлена, отменена пользователем или отменена в связи с окончанием количества попыток.
При активации настройки доступ к услугам сохраняется, пока попытки не будут истрачены.
При продлении подписки пользователем до окончания количества попыток списания, дни, в течение которых пользователю сохранялся доступ к сервису партнера без фактической оплаты, вычитаются из общего числа доступных пользователю дней, так как они считаются использованными.

Автоматический платеж

Тип продления подписки, при котором списания происходят автоматически с сохраненного платежного аккаунта. Участие пользователя при этом не требуется. Если платежный аккаунт не сохранен, подписка с автоматическим типом платежей переходит в статус Non renewing.

Единовременный платеж

Тип продления подписки, при котором списания осуществляются пользователем через ссылку на оплату, полученную по электронной почте. Используется, если пользователь выбирает способ оплаты, не поддерживающий автоматические платежи.

Статусы подписок

Подписка может находиться в одном из следующих статусов:

Active. Основной статус подписки. Подписка создается и активируется после первого успешного платежа. Повторные списания средств осуществляются только у активных подписок.

Подписку нельзя создать вручную, через API. Она создается только автоматически при совершении покупки.

Canceled. Подписка отменена. При переходе в статус Canceled подписка перестает действовать немедленно. Возможные причины отмены:
- Изменился статус подписки через вызов API метода или настройки в Личном кабинете Иксолла.
- Пользователь отменил подписку.
- Закончился срок действия подписки (если был задан параметр expiration date).
- Превышено максимальное количество попыток списания средств при продлении подписки (значение по умолчанию — 3, может быть изменено через обращение к аккаунт-менеджеру проекта).
- Пользователь, у которого была данная подписка, не был найден при проверке существования пользователя в игре.
- Платежный аккаунт пользователя, к которому привязана данная подписка, был удален.

Отмена подписки может осуществляться с возвратом последнего платежа. Данная опция доступна и для партнера, и для пользователя.

Non renewing. Продление подписки отменено. Подписка будет действовать до окончания текущего платежного цикла и затем перейдет в статус Canceled. Возможные причины отмены продления:
- Изменился статус подписки через вызов API метода или настройки в Личном кабинете Иксолла.
- Пользователь отменил продление по ссылке в письме.
- Платежный аккаунт пользователя, к которому привязана данная подписка, был удален.

Прогресс интеграции

Последнее обновление: 29 декабря 2021

Нашли опечатку или ошибку в тексте? Выделите ее и нажмите Ctrl+Enter.