Подписка в подарок

Вы можете добавить в ваше приложение возможность подарить подписку другому пользователю. Это поможет привлечь дополнительную прибыль или новых пользователей.

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

Пользователь может подарить подписку существующему в вашей системе пользователю, указав данные его аккаунта, или новому пользователю, указав его email-адрес. При этом пользователь, отправляющий подарок, может скрыть свое имя или добавить текст сообщения в email-уведомление о подарке. После создания подписки её владельцем становится получатель подарка. Созданная подписка принимает тип продления единовременный платеж.

Схема взаимодействия при подарке подписки существующему пользователю:

Схема взаимодействия при подарке подписки новому пользователю:

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

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

• существующему пользователю;
• новому пользователю.

Подарок существующему пользователю

1. Реализуйте в вашем приложении интерфейс для  покупки подписки в подарок со следующими элементами:
   • поля для ввода данных получателя подарка;
   • поле ввода сообщения от отправителя (опционально);
   • опцию для выбора анонимной отправки (опционально);
   • элементы для выбора плана подписки (опционально).

2. Реализуйте получение токена после заполнения данных о подарке, при переходе к оплате. Для этого передайте в метод Создание токена объект purchase.subscription.gift c параметрами:
   • recipient — ID получателя подписки. Обязательный.
   • email — email-адрес получателя. Обязательный.
   • redirect_url — URL переадресации. Передайте ссылку на страницу с дополнительной информацией о подаренной подписке или на главную страницу проекта.

• Дополнительно вы можете передать в объекте purchase.subscription параметры:
  • gift.anonymous — отправлен ли подарок анонимно. Если значение true, имя отправителя будет скрыто в email-уведомлении. По умолчанию принимает значение false.
  • gift.message — сообщение от отправителя подарка. Будет отправлено в email-уведомлении о подаренной подписке.
  • plan_id — ID плана подписки.

Пример запроса на получение токена:

{
  "purchase": {
    "checkout": {
      "currency": "USD",
      "amount": 10
    },
    "subscription": {
      "gift": {
        "recipient": "test_recipient_v1",
        "email": "recipient_email@email.com",
        "redirect_url": "https://example.com/",
        "anonymous": true,
        "message": "Happy birthday!"
      }
    }
  },
  "settings": {
    "currency": "USD",
    "language": "en",
    "project_id": 16184,
    "ui": {
      "components": {
        "virtual_currency": {
          "custom_amount": true
        }
      },
      "desktop": {
        "virtual_item_list": {
          "button_with_price": true,
          "layout": "list"
        }
      },
      "size": "medium"
    }
  },
  "user": {
    "country": {
      "allow_modify": true,
      "value": "US"
    },
    "age": 19,
    "email": {
      "value": "john.smith@mail.com"
    },
    "id": {
      "value": "user_2"
    },
    "name": {
      "value": "John Smith"
    }
  }
}

3. Используя токен, полученный на шаге 2, реализуйте открытие платежного интерфейса в новом окне, в Iframe или c помощью Pay Station Embed.

Подарок новому пользователю

1. Реализуйте в вашем приложении интерфейс для покупки подписки в подарок со следующими элементами:
   • поля для ввода email-адреса получателя подарка;
   • поле ввода сообщения от отправителя (опционально);
   • опцию для выбора анонимной отправки (опционально);
   • элементы для выбора плана подписки (опционально).
2. Реализуйте создание нового пользователя и присвоение ему ID в вашей системе.
3. Реализуйте создание ссылки для активации аккаунта пользователя.

4. Реализуйте получение токена после заполнения данных о подарке, при переходе к оплате. Для этого передайте в метод Создание токена объект purchase.subscription.gift c параметрами:
   • recipient — ID получателя подписки, созданный на шаге 2.
   • email — email-адрес получателя.
   • redirect_url — URL активации, созданный на шаге 3.

• Дополнительно вы можете передать в объекте purchase.subscription параметры:
  • gift.anonymous — отправлен ли подарок анонимно. Если значение true, имя отправителя будет скрыто в email-уведомлении. По умолчанию принимает значение false.
  • gift.message — сообщение от отправителя подарка. Будет отправлено в email-уведомлении о подаренной подписке.
  • plan_id — ID плана подписки.

Пример запроса на получение токена:

{
  "purchase": {
    "checkout": {
      "currency": "USD",
      "amount": 10
    },
    "subscription": {
      "gift": {
        "recipient": "test_recipient_v1",
        "email": "recipient_email@email.com",
        "redirect_url": "https://example.com/",
        "anonymous": true,
        "message": "Happy birthday!"
      }
    }
  },
  "settings": {
    "currency": "USD",
    "language": "en",
    "project_id": 16184,
    "ui": {
      "components": {
        "virtual_currency": {
          "custom_amount": true
        }
      },
      "desktop": {
        "virtual_item_list": {
          "button_with_price": true,
          "layout": "list"
        }
      },
      "size": "medium"
    }
  },
  "user": {
    "country": {
      "allow_modify": true,
      "value": "US"
    },
    "age": 19,
    "email": {
      "value": "john.smith@mail.com"
    },
    "id": {
      "value": "user_2"
    },
    "name": {
      "value": "John Smith"
    }
  }
}

5. Используя токен, полученный на шаге 4, реализуйте открытие платежного интерфейса в новом окне, в Iframe или c помощью Pay Station Embed.