Last Updated: 9/6/2021, 8:19:04 AM

# Subscriptions

# Overview

We support a subscription feature to help you monetize your video games. You can create a set of subscription plans for the players, manage the subscription content such as choosing the game or item as exclusive content for each plan, and you can also decide the price for each plan. Players can sign up for their desired plans and will be able to access all of the exclusive content in the plans through the player portal.

catalog

# Prerequisites and Permissions

# Prerequisites

Before you can manage your subscriber, make sure you have created the subscription plan and manage the subscription content and publish your store live.

# Permissions

Permissions are used to grant access to specific resources within our services. Make sure your account has the following permissions before you attempt to manage subscriptions in the Admin Portal. For a full list of permissions that impact subscription management, see the Platform/Commerce tab of the permissions reference (opens new window).

Usage Permission Tag Action
Add or Remove Subscription Time ADMIN:NAMESPACE:{namespace}:USER:{userId}:SUBSCRIPTION UPDATE
Cancel a Subscription ADMIN:NAMESPACE:{namespace}:USER:{userId}:SUBSCRIPTION UPDATE

Permissions work slightly differently depending on whether they are assigned to IAM Clients or Roles assigned to users. For more information, read the Authentication and Authorization documentation.

# Managing Subscriptions in the Admin Portal

# Add or Remove Subscription Time

You can add or remove subscription time for a player by following the steps below.

  1. In the Admin Portal, go to the Subscriptions section and click on the Subscribers menu.

    catalog

  2. Find the player whose subscription time you want to modify. Ensure that the player already has an active subscription.

    catalog

  3. In the Basic Information section, click Add Days to grant more days to the player or click Remove Days to remove days from the subscription.

    catalog

  4. A pop-up window will appear. Fill in the required information.

    a. Add Subscriptions

    • Input how many days you want to add in the Amount field.

    catalog

    b. Remove Subscriptions

    • Input how many days you want to remove in the Amount field. The number of days removed cannot be greater than the days between now and the expiry date.

    catalog

  5. Once you’ve confirmed your modification to the player’s subscription, the player will be immediately notified via email.

# Cancel a Subscription

You can cancel a player’s subscription by following the steps below:

  1. In the Admin Portal, find the player whose subscription you want to cancel. Then, in the Basic Information section, click the Cancel button to cancel the subscription.

    catalog

  2. A pop-up window will appear. Here you can confirm the cancellation by clicking the Yes, Cancel button.

    catalog

# Managing Subscriptions using API

# Add or Remove Subscription Time

To add or remove subscription time for a player:

  1. Use the Grant Days to a Subscription: PUT - ​/admin​/namespaces​/{namespace}​/users​/{userId}​/subscriptions​/{subscriptionId}​/grant endpoint.

  2. Input the Namespace field with the Publisher Namespace.

  3. Input the User ID of the player to whom you want to grant or remove subscription time.

  4. Input the Subscription ID.

  5. Fill out the Request Body.

    • Input the Grant Days. Input a positive number to add more days to the subscription, or input a negative number to remove days from the subscription.
    • Input the Reason why you are adding or removing time from the subscription.

Upon successful request, the subscription period of the player will be changed. Here is an example of a response to a successful request:

# Cancel a Subscription Using API

  1. Use the Cancel a Subscription: PUT - ​/admin​/namespaces​/{namespace}​/users​/{userId}​/subscriptions​/{subscriptionId}​/cancel endpoint.

  2. Input the User ID of the player for whom you want to cancel the subscription.

  3. Input the Subscription ID.

  4. Fill out the Request Body.

    • Set the immediate option to true if you want to terminate the subscription immediately. Otherwise, the subscription will end at the end of the current billing cycle.
    • Input the Reason why you want to cancel the player’s subscription.

Upon successful request, the player’s subscription will be canceled. Here is an example of a response to a successful request: