С чего начать
Сценарий интеграции
Чтобы подключить Subscriptions:
- Создайте проект.
- Настройте планы подписок.
- Настройте авторизацию.
- Создайте каталог.
- Настройте открытие платежного интерфейса.
- Настройте получение информации о подписках.
- Подпишите лицензионный договор.
Как это работает
Покупка подписки
Автоматическое обновление рекуррентной подписки
Сценарий пользователя
Глоссарий
План подписки
Продукт подписки
Подписка
Сочетание продукта и выбранного плана. Подписка создается, когда пользователь выбирает план подписки и получает доступ к услуге. Количество созданных подписок, которые пользователь может оформить одновременно, зависит от количества продуктов в проекте. Условия подписки (расчетный период, стоимость и другие) соответствуют условиям выбранного плана. Если условия плана изменяются после создания подписки, условия существующей подписки не меняются.
ПРИМЕР 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 отправляются вебхуки о платеже и продлении подписки или об отмене, если оплата подписки не удалась. Пробный период не входит в период действия плана и его длительность считается отдельно.
- Пробный период может быть добавлен в качестве бонуса в промоакцию.
Льготный период (грейс-период)
- Льготный период предусмотрен только для подписок с обычным типом плана и единовременным платежом. Для автопродлеваемых подписок средства списываются автоматически.
- Xsolla уведомляет пользователя о необходимости произвести оплату в момент активации льготного периода и каждый последующий день действия льготного периода.
- При оплате пользователем подписки во время действия льготного периода, оплата производится за полный платежный период.
- Количество дней, в течение которых у пользователя сохранялся доступ к сервису партнера без фактической оплаты, вычитается из общего количества дней в данном периоде действия подписки.
- Если в настройке плана в поле Льготный период установлено значение
0
, такой план не имеет льготного периода.
Период попыток списания (ретрай-период)
- Период попыток списания период предусмотрен только для подписок с обычным типом плана и автоматическим типом платежей.
- Попытки списания средств осуществляются с сохраненного платежного аккаунта раз в сутки.
- Попытки списания продолжаются до тех пор, пока подписка не будет продлена, отменена пользователем или отменена в связи с окончанием количества попыток.
- При продлении пользователем подписки до окончания периода попыток списания, количество дней, в течение которых у пользователя сохранялся доступ к сервису партнера без фактической оплаты, вычитается из общего количества доступных дней в данном периоде действия подписки.
- Если в настройке плана в поле Количество попыток списания установлено значение
0
, такой план не имеет периода попыток списания.
Автоматический платеж
Единовременный платеж
Статусы подписок
Подписка может находиться в одном из следующих статусов:
- Active. Основной статус подписки. Подписка создается и активируется после первого успешного платежа. Повторные списания средств осуществляются только у активных подписок.
- Canceled. Подписка отменена. При переходе в статус Canceled подписка перестает действовать немедленно. Возможные причины отмены:
- Изменился статус подписки через вызов API метода или настройки в Личном кабинете Xsolla.
- Пользователь отменил подписку.
- Закончился срок действия подписки (если был задан параметр expiration date).
- Превышено максимальное количество попыток списания средств при продлении подписки (значение по умолчанию — 3, может быть изменено через обращение к персональному менеджеру проекта или на почту csm@xsolla.com).
- Пользователь, у которого была данная подписка, не был найден при проверке существования пользователя в игре.
- Платежный аккаунт пользователя, к которому привязана данная подписка, был удален.
- Non renewing. Продление подписки отменено. Подписка будет действовать до окончания текущего платежного цикла и затем перейдет в статус Canceled. Возможные причины отмены продления:
- Изменился статус подписки через вызов API метода или настройки в Личном кабинете Xsolla.
- Пользователь отменил продление по ссылке в письме.
- Платежный аккаунт пользователя, к которому привязана данная подписка, был удален.
Нашли опечатку или ошибку в тексте? Выделите ее и нажмите Ctrl+Enter.