Set up subscription plan

  1. Open your project in Publisher Account.
  2. Go to the Subscriptions section.
  3. On the Subscription plan tab, click Create subscription plan.

  1. Choose and set up a plan type:

Note
All plans created through Publisher Account are assigned an External ID value which allows you to:
  • Open a payment UI with a specific plan.
  • Identify the plan in alerts.
  • Identify the plan in a transactional report.
If you need to manually specify the External ID, create a plan using the Create Plan API endpoint.

Set up regular plan

  1. On the Subscription info step, specify:
    1. Plan name: Select a name for your plan.
    2. Description (optional): This plan description is displayed in the payment UI when users are purchasing a subscription.

  1. Click Next.
  2. On the Payment Information step, select a method for defining the cost of your subscription fee:
    1. Set the price associated with the first payment: The amount of each payment is equal to the first payment made by the user.
    2. Set another price: The amount of each payment is set manually. When you select this option, specify the price and currency in the field that appears.

  1. Configure the billing cycle:
    1. Billing cycle: Specify the frequency of payment.
    2. Trial period: Specify the number of days in the trial period where the subscription can be used without a payment. Set the value to 0 to create a plan that does not have a trial period.

  1. Specify parameters for a one-time payment: this type of subscription renewal is where a user makes a payment via a payment link sent through email.
    1. Expiration reminder: Specify the number of days before a subscription expiration date when the user will receive a reminder. If the value is set to 6 or higher, the user receives an extra reminder one day before the expiration date. Set the value to 0 if you don’t want to send any reminders.
    2. Grace period: The number of days a will be able to continue using their subscription after it has passed its expiration date, and has the option to renew it. Set the value to 0 to create a plan that does not have a grace period.

  1. Specify the parameters for an automatic payment: with this type of subscription renewal, payments are made automatically using the saved billing information, with no user actions required.
    1. Subscription expiration reminder.
    2. The number of billing retries after the first unsuccessful attempt to charge a user for the subscription. The system will retry to charge a user once a day.

  1. Click Next.
  2. On the Other settings step, enable bonuses for subscribers (optional):
    1. Set the Send bonuses to subscribers toggle to On.
    2. Specify frequency of bonuses.
    3. Add virtual items or virtual currency that you want to send as a bonus.
    4. Add a commentary for a subscriber (optional). The commentary appears in the transaction history in Pay Station.

Note
If the Send bonuses to subscribers toggle is not active, make sure you set up the Virtual currency or Virtual items modules.

Set up lifetime plan

  1. On the Subscription Info step, specify:
    1. Plan name: Select a name for your plan.
    2. Description (optional): This plan description is displayed in the payment UI when users are purchasing a subscription.

  1. Click Next.
  2. On the Payment information step, select a method for defining the cost of your subscription:
    1. Set the price associated with the first payment: The amount of each payment is equal to the first payment made by the user.
    2. Set another price: The amount of each payment is set manually. When you select this option, specify the price and currency in the field that appears.
  3. In the Refund period field, set the number of days when the user can unsubscribe and refund the payment.

  1. Click Next.
  2. On the Other settings step, enable bonuses for subscribers (optional):
    1. Set the Send bonuses to subscribers toggle to On.
    2. Specify frequency of bonuses.
    3. Add virtual items or virtual currency that you want to send as a bonus.
    4. Add a commentary for a subscriber (optional). The commentary appears in the transaction history in Pay Station.

Note
If the Send bonuses to subscribers toggle is not active, make sure you set up the Virtual currency or Virtual items modules.

Set up season pass

  1. On the Subscription Info step, specify:
    1. Plan name: Select a name for your plan.
    2. Time period: Season pass validity period.
    3. Description (optional): This plan description is displayed in the payment UI when users are purchasing a subscription.

  1. Click Next.
  2. On the Payment information step, select a method for defining the cost of your subscription:
    1. Set the price associated with the first payment: The amount of each payment is equal to the first user’s payment.
    2. Set another price: The amount of each payment is set manually. When you select this option, specify the price and currency in the field that appears.
  3. In the Refund period field, set the number of days when the user can unsubscribe and refund the payment.

  1. Click Next.
  2. On the Other settings step, enable bonuses for subscribers (optional):
    1. Set the Send bonuses to subscribers toggle to On.
    2. Specify frequency of bonuses.
    3. Add virtual items or virtual currency that you want to send as a bonus.
    4. Add a commentary for a subscriber (optional). The commentary appears in the transaction history in Pay Station.

Note
If the Send bonuses to subscribers toggle is not active, make sure you set up the Virtual currency or Virtual items modules.

Test purchasing a subscription

To see the purchase process from the user’s point of view, you can test the purchase of a subscription with real or test payments. To do this:

  1. In the Subscriptions > Subscription plans tab go to the Test purchase flow block and click the Test button.

  1. Click Generate purchase URLs to get test links and an example of a token.

  1. Test your subscription purchase with test or real payments:
    • To make a test payment, click the Sandbox URL link and purchase subscription using a test card.

Note
In Sandbox mode you can use only test bank cards. Sandbox bank card payments can be made in the following currencies: USD, EUR, RUB, GBP, AED, ALL, AMD, ARS, AUD, AZN, BGN, BRL, BYN, CAD, CHF, CLP, CNY, COP, CZK, DKK, DZD, EGP, GEL, HKD, HRK, HUF, IDR, ILS, INR, ISK, JPY, KES, KGS, KRW, KZT, MAD, MDL, MKD, MNT, MXN, MYR, NGN, PEN, PHP, PKR, PLN, RON, RSD, SAR, SEK, SGD, THB, TRY, TWD, UAH, UYU, UZS, VEF, VND, ZAR.

    • To test your purchase with real payments:
      1. Sign a License agreement. To do this, go to Publisher Account > Accounting > License agreement, complete the agreement form, and wait for confirmation.

Note
Signing the License Agreement activates the sale of real subscriptions.

      1. Click the Production URL link and make the payment with a valid bank card.

Note
It is recommended to use Visa and MasterCard cards to test real payments.

    • To refund your payment:
      1. Go to Publisher Account > Support > Transaction search.
      2. Choose your test transaction and click the More (•••) menu button.
      3. Click Refund in the pop-up menu (to initiate a refund the transaction should have Complete status).

Your progress
Thank you for your feedback!
Last updated: September 12, 2022

Found a typo or other text error? Select the text and press Ctrl+Enter.

Report a problem
We always review our content. Your feedback helps us improve it.
Provide an email so we can follow up
Thank you for your feedback!