Set up subscription plan

You can set up subscription plans via Publisher Account or with the Create plan API call.

To set up a plan via Publisher Account:

  1. Go to the Subscriptions section.
  2. On the Subscription plan tab, click Create subscription plan.
  1. Choose and set up the 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 specify the External ID, create a plan with the Create Plan API call.

Set up regular plan

  1. Specify:
    1. Plan name.
    2. Description (optional): This plan description is displayed in the payment UI when users are purchasing a subscription.

  1. Click Next.
  2. Choose one of the subscription fee options:
    • Regular: the amount of each payment is specified manually.
    • Including setup fee: the amount of each payment as well as the amount of the setup fee are specified manually. Use this setting if you want to charge the subscriber for cover additional costs such as connecting a license, setting up a system, training a user, or providing a consultation The first payment in this case will include a setup fee, the remaining payments will be equal to the amount of the regular payment.
Note
If your project does not have the ability to set up a subscription fee with setup fee and prices for different currencies, contact your Customer Success Manager or email to csm@xsolla.com to enable multi currency in the project.

    • Associated with the first payment: the amount of each payment is equal to the first payment. The subscription cost and currency type are passed in the purchase.checkout.amount and purchase.checkout.currency parameters when opening the payment UI. Use this option if you want to manage pricing on your side and set individual prices for specific users.

  1. Whether you choose a regular subscription fee or with setup fee, you can set up different subscription prices for different currencies. To do this:

    1. In the Currency and Price field, select the required currency and specify the value of the subscription price. For a subscription with setup fee, also enter the value of the setup fee in the corresponding field.
    1. Click + to add prices in other currencies.
    1. Specify the default currency.
  1. Configure the billing cycle:
    1. Specify the frequency of the payment.
    2. 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. With this type of subscription renewal, users make payments via a payment link sent by email.
    1. Expiration reminder: Specify the number of days before the 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 users can continue using their subscription after its expiration date, and have 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 without any user interaction.
    1. Subscription expiration reminder.
    2. The number of retries after the first unsuccessful attempt to charge for the subscription. The system will retry once a day.
  1. Click Next.
Note
Setting up bonuses in the Publisher Account is currently unavailable. To enable sending bonuses, contact your Customer Success Manager or email to csm@xsolla.com.
  1. Click Create.

Set up lifetime plan

  1. Specify:
    1. Plan name.
    2. Description (optional): This plan description is displayed in the payment UI when users are purchasing a subscription.

  1. Click Next.
  2. Choose one of the subscription fee options:
    • Regular: the amount of each payment is specified manually.
    • Associated with the first payment: the amount of each payment is equal to the first payment made by the user. The subscription cost and currency type are passed in the purchase.checkout.amount and purchase.checkout.currency parameters when opening the payment UI. Use this option if you want to manage pricing on your side and be able to set the individual price for a specific user.

  1. In the Refund period field, set the number of days when the user can unsubscribe and refund the payment.

  1. Whether you choose a regular subscription fee, you can set up different subscription prices for different currencies. To do this:
Note
If your project does not have the ability to set up prices for different currencies, contact your Customer Success Manager or email to csm@xsolla.com to enable multi currency in the project.
    1. In the Currency and Price field, select the required currency and specify the value of the subscription price.
    1. Click + to add prices in other currencies.
    1. Specify the default currency.
  1. Click Next.

Note
Setting up bonuses in the Publisher Account is currently unavailable. To enable sending bonuses, contact your Customer Success Manager or email to csm@xsolla.com.
  1. Click Create.

Set up season pass

  1. Specify:
    1. Plan name.
    2. 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. Choose one of the subscription fee options:
    • Regular: the amount of each payment is specified manually.
    • Associated with the first payment: the amount of each payment is equal to the first payment made by the user. The subscription cost and currency type are passed in the purchase.checkout.amount and purchase.checkout.currency parameters when opening the payment UI. Use this option if you want to manage pricing on your side and be able to set the individual price for a specific user.

  1. In the Refund period field, set the number of days when the user can unsubscribe and refund the payment.

  1. Whether you choose a regular subscription fee, you can set up different subscription prices for different currencies. To do this:
Note
If your project does not have the ability to set up prices for different currencies, contact your Customer Success Manager or email to csm@xsolla.com to enable multi currency in the project.
    1. In the Currency and Price field, select the required currency and specify the value of the subscription price.
    1. Click + to add prices in other currencies.
    1. Specify the default currency.
  1. Click Next.
Note
Setting up bonuses in the Publisher Account is currently unavailable. To enable sending bonuses, contact your Customer Success Manager or email to csm@xsolla.com.
  1. Click Create.

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 side menu, click Subscriptions and go to the Subscription plans tab. Then, 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 Real payment 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: October 10, 2023

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!