Как разрешить пользователю сменить план подписки

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

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

• Если валюта нового плана отличается от валюты текущего плана, покупка нового плана будет выполнена с конвертацией валют.

• у пользователя уже есть активная подписка с планом, на который меняется текущий план;
• подписка, которую пользователь хочет сменить, не находится в статусе Active;
• план подписки, который пользователь хочет сменить, имеет тип Бесконечный план — такую подписку можно отменить только в указанный период возврата.

Как настроить

1. Откройте проект в Личном кабинете.
2. Нажмите Subscriptions в боковом меню и перейдите в раздел Настройки.
3. В разделе Изменение плана подписки установите переключатель Возможность выбрать другой план подписки в положение Вкл.
4. По умолчанию смена плана разрешена со следующего периода. Чтобы разрешить смену плана в текущем периоде, выберите пункт Текущее время. При выборе этой опции план будет меняться сразу после подтверждения оплаты.
5. Чтобы разрешить смену плана более одного раза в день, установите переключатель Возможность выбрать другой план подписки несколько раз в день в положение Вкл.
6. При открытии платежного интерфейса используйте:
   • серверный метод создания токена;
   • клиентский метод получения ссылки на открытие платежного интерфейса, если в проекте настроен Xsolla Login.

Открытие платежного интерфейса с помощью серверного метода создания токена

1. Получите токен для открытия платежного интерфейса. При этом передайте в метод:
   • значение change_plan в параметре purchase.subscription.operation;
   • ID нового плана в параметре purchase.subscription.plan_id;
   • ID продукта подписки в параметре purchase.subscription.product_id, если вы используете продукты подписки. Для его получения обратитесь к персональному менеджеру проекта или напишите на csm@xsolla.com.
2. Откройте платежный интерфейс одним из способов:
   • с помощью скрипта Pay Station Embed;
   • в iframe;
   • в новом окне.

Открытие платежного интерфейса на странице управления подписками с помощью клиентского метода

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

Чтобы сделать это, в клиентской части вашего приложения реализуйте получение ссылки на платежный интерфейс с использованием HTTP POST-запроса https://subscriptions.xsolla.com​/api/user/v1/projects/{project_id}/subscriptions/manage. Запрос к методу должен содержать заголовок Authorization: Bearer <client_user_jwt>, где <client_user_jwt> — JSON Web Token (JWT) пользователя — уникальный токен, закодированный по стандарту Base64. Используйте для его получения:

• Методы API Register new user и Auth by username, если в вашем приложении используется авторизация по логину и паролю.
• Метод API Auth via social network, если в вашем приложении используется авторизация через социальные сети.

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

Параметры тела запроса:

curl -X 'POST' \
'https://subscriptions.xsolla.com/api/user/v1/projects/{project_id}/subscriptions/manage?country=RU  ' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer client_user_jwt'
{
  "settings": {
    "ui": {
      "size": "large",
      "theme": "string",
      "version": "desktop",
      "desktop": {
        "header": {
          "is_visible": true,
          "visible_logo": true,
          "visible_name": true,
          "type": "compact",
          "close_button": true
        }
      },
      "mobile": {
        "mode": "saved_accounts",
        "footer": {
          "is_visible": true
        },
        "header": {
          "close_button": true
        }
      },
      "license_url": "string",
      "mode": "user_account",
      "user_account": {
        "history": {
          "enable": true,
          "order": 1
        },
        "payment_accounts": {
          "enable": true,
          "order": 1
        },
        "info": {
          "enable": true,
          "order": 1
        },
        "subscriptions": {
          "enable": true,
          "order": 1
        }
      }
    },
    "currency": "str",
    "locale": "st",
    "external_id": "string",
    "payment_method": 1,
    "return_url": "string",
    "redirect_policy": {
      "redirect_conditions": "none",
      "delay": 0,
      "status_for_manual_redirection": "none",
      "redirect_button_caption": "string"
    }
  }
}

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

{
  "link_to_ps": "https://secure.xsolla.com/paystation2/?access_token=<access_token>"
}