en zh

Manage Subscriptions

Subscriptions are assigned a unique product ID. Before or after a subscription’s purchase, your app can request app-related details about the subscription using this product ID.

When a subscription purchase and payment transaction is successful, Samsung IAP assigns a unique purchase ID to the subscription. Your app server uses this purchase ID to get app-related or user-related details about the subscription.

App-Related details can be requested before or after a subscription is purchased and include the information you configured for the subscription in Seller Portal (such as subscription period length, pricing options, availability period, and price).

User-Related details can be requested after a subscription is purchased and include current details about the user’s subscription (such as the subscription status, current price paid, and number of renewals).

If your app does not receive the purchase ID (for example, due to network issues), you can use getOwnedList() to request it.

The following API calls are used to manage your subscriptions (click on the API call to see more detailed information):

• getOwnedList() (IAP SDK API) – Get a list of subscriptions owned by the user that are currently in a free trial or active subscription period. The response is an array of objects (OwnedProductVo). The app can check the availability of a subscription by referring to the onGetOwnedProducts() data. This API provides meaningful information after a subscription is purchased. Use this call when the app is launched to determine if the user has successfully subscribed to or auto-renewed a subscription. Subscriptions that have been cancelled are included in the response until the active subscription period has ended.

  Subscription-related objects include the product ID, purchase ID, current price, purchase date, and current subscription period end date.

  

• getProductsDetails() (IAP SDK API) – Get details about a subscription that was configured in Seller Portal. This call requires the product ID of the subscription. The response is an array of objects (ProductVo). This API can be called before or after a subscription is purchased.

  Subscription-related objects include the current price, subscription period length, subscription pricing option, availability period, duration of free trial period.

• iap/v6/receipt (IAP Server API) – Verify a subscription purchase and payment transaction were successfully completed. This call requires the purchase ID of the subscription. Information is returned in a SOAP response. This API can be called before or after a subscription is purchased.

  Subscription-related content include the subscription identifier, payment transaction identifier, purchase receipt identifier, name of the subscription, description of the subscription, date and time of purchase and payment transaction, total amount billed (includes subscription price and all applicable taxes), and payment transaction status.

• iap/seller/subscription (IAP Server API) – Get the subscription status, subscription information, and purchase information, used to verify the purchase of a subscription. This call requires the purchase ID of the subscription and a service token for authentication and checks the user’s subscription information on the seller’s back-end server. Information is returned in a REST response. This API provides meaningful information after a subscription is purchased.

  Subscription-related content include the purchase date, current subscription status, current price, current subscription pricing option, number of renewals, paid subscription start date, subscription end date, and reason for cancellation.

  

For more details about these and other API calls, see the Samsung IAP Programming Guide.

Email receipts

Samsung IAP sends subscription purchasers emails about significant events:

• Free trial sign-up email: Sent after initial purchase of a subscription with a free trial. Contains subscription and order information.

• Subscription purchase email: Sent after initial purchase of a subscription without a free trial, when a subscription is renewed, and after subscription repurchases. Contains subscription and payment information, including the price paid for the subscription’s first period of use (for example, a free trial ($0), a lower-tier price, or a regular-tier price).

• Free trial expiration email: Sent 7 days before the end of a free trial period. Contains subscription information.

• Subscription renewal email (India customers only): Sent seven (7) days before the end of the subscription period and indicates that their consent is needed to renew the subscription. Details about the steps needed to renew the subscription in Galaxy Store are included. Contains subscription information.

• Subscription renewal email (all customers, except those in India): Sent near the end of each lower-tier or regular subscription period, which indicates that an auto-payment for the next subscription period will happen soon. Contains product and subscription information.

• Grace period email: Sent during the renewal process if there is an issue with the payment method. The customer is asked to update their payment method in Galaxy Store (Menu > Subscriptions > Subscription Details Page > Payment Method). By default, the customer has one day to update their payment method before the subscription is cancelled. A longer grace period (3, 7, 14, or 30 days) for the subscription can be configured in Seller Portal. If the issue continues after the grace period (the customer does not update their payment method), the subscription is automatically cancelled.

• Subscription cancellation email: Sent after a subscription is cancelled, either by the user or for another reason. Contains subscription information.

Register a subscription

See Register an app and in-app products in Seller Portal in the IAP Programming Guide for more information.

Re-Subscribe to a cancelled subscription

If a customer has cancelled their subscription but the current subscription hasn't expired, they are able to reconsider their decision and reactivate the subscription. The customer must resubscribe before the end of the current subscription period.

Customers can resubscribe by launching the Galaxy Store app on their phone and tapping Menu > Subscriptions > Subscription Details Page > Resubscribe. The subscription uses the same payment cycle and method as before.

If you send a notification to the customer about resubscribing before the end of the current subscription period, you can include a link that opens the subscription detail page of your app in Galaxy Store (see Deep link to subscription detail page in Galaxy Store below for more information about the deep link).

Deep link to subscription detail page in Galaxy Store

You can provide a link directly to the subscription detail page of your app in Galaxy Store. This allows your customers to quickly manage their subscription, such as consenting to a price change, resubscribing, or updating their payment method.

Use the following deep link to the app's subscription detail page:

samsungapps://SubscriptionDetail?purchaseId={purchaseId}

where {purchaseId} is the unique purchase ID of the subscription.

We suggest that you include this deep link in the settings menu of your app so that users can easily find the subscription detail page in Galaxy Store.

Test subscriptions

See Testing Subscriptions in the IAP Test Guide for more information.