com.google.api.services.androidpublisher

Class AndroidPublisher.Purchases.Subscriptions

java.lang.Object

com.google.api.services.androidpublisher.AndroidPublisher.Purchases.Subscriptions

Enclosing class:

AndroidPublisher.Purchases

public class AndroidPublisher.Purchases.Subscriptions
extends Object

The "subscriptions" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AndroidPublisher.Purchases.Subscriptions.Acknowledge
class	AndroidPublisher.Purchases.Subscriptions.Cancel
class	AndroidPublisher.Purchases.Subscriptions.Defer
class	AndroidPublisher.Purchases.Subscriptions.Get
class	AndroidPublisher.Purchases.Subscriptions.Refund
class	AndroidPublisher.Purchases.Subscriptions.Revoke

Constructor Summary

Constructors

Constructor and Description
Subscriptions()

Method Summary

Modifier and Type	Method and Description
AndroidPublisher.Purchases.Subscriptions.Acknowledge	acknowledge(String packageName, String subscriptionId, String token, SubscriptionPurchasesAcknowledgeRequest content) Acknowledges a subscription purchase.
AndroidPublisher.Purchases.Subscriptions.Cancel	cancel(String packageName, String subscriptionId, String token) Cancels a user's subscription purchase.
AndroidPublisher.Purchases.Subscriptions.Defer	defer(String packageName, String subscriptionId, String token, SubscriptionPurchasesDeferRequest content) Defers a user's subscription purchase until a specified future expiration time.
AndroidPublisher.Purchases.Subscriptions.Get	get(String packageName, String subscriptionId, String token) Deprecated: Use purchases.subscriptionsv2.get instead.
AndroidPublisher.Purchases.Subscriptions.Refund	refund(String packageName, String subscriptionId, String token) Deprecated: Use orders.refund instead.
AndroidPublisher.Purchases.Subscriptions.Revoke	revoke(String packageName, String subscriptionId, String token) Deprecated: Use purchases.subscriptionsv2.revoke instead.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Subscriptions

public Subscriptions()

Method Detail

acknowledge

public AndroidPublisher.Purchases.Subscriptions.Acknowledge acknowledge(String packageName,
                                                                        String subscriptionId,
                                                                        String token,
                                                                        SubscriptionPurchasesAcknowledgeRequest content)
                                                                 throws IOException

Acknowledges a subscription purchase. Create a request for the method "subscriptions.acknowledge". This request holds the parameters needed by the androidpublisher server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

packageName - The package name of the application for which this subscription was purchased (for example, 'com.some.thing').

subscriptionId - Note: Since May 21, 2025, subscription_id is not required, and not recommended for subscription with add-ons. The purchased subscription ID (for example, 'monthly001').

token - The token provided to the user's device when the subscription was purchased.

content - the SubscriptionPurchasesAcknowledgeRequest

Returns:

the request

Throws:

IOException

cancel

public AndroidPublisher.Purchases.Subscriptions.Cancel cancel(String packageName,
                                                              String subscriptionId,
                                                              String token)
                                                       throws IOException

Cancels a user's subscription purchase. The subscription remains valid until its expiration time. Newer version is available at purchases.subscriptionsv2.cancel for better client library support. Create a request for the method "subscriptions.cancel". This request holds the parameters needed by the androidpublisher server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

packageName - The package name of the application for which this subscription was purchased (for example, 'com.some.thing').

subscriptionId - Note: Since May 21, 2025, subscription_id is not required, and not recommended for subscription with add-ons. The purchased subscription ID (for example, 'monthly001').

token - The token provided to the user's device when the subscription was purchased.

Returns:

the request

Throws:

IOException

defer

public AndroidPublisher.Purchases.Subscriptions.Defer defer(String packageName,
                                                            String subscriptionId,
                                                            String token,
                                                            SubscriptionPurchasesDeferRequest content)
                                                     throws IOException

Defers a user's subscription purchase until a specified future expiration time. Create a request for the method "subscriptions.defer". This request holds the parameters needed by the androidpublisher server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

packageName - The package name of the application for which this subscription was purchased (for example, 'com.some.thing').

subscriptionId - The purchased subscription ID (for example, 'monthly001').

token - The token provided to the user's device when the subscription was purchased.

content - the SubscriptionPurchasesDeferRequest

Returns:

the request

Throws:

IOException

get

public AndroidPublisher.Purchases.Subscriptions.Get get(String packageName,
                                                        String subscriptionId,
                                                        String token)
                                                 throws IOException

Deprecated: Use purchases.subscriptionsv2.get instead. Checks whether a user's subscription purchase is valid and returns its expiry time. Create a request for the method "subscriptions.get". This request holds the parameters needed by the androidpublisher server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

packageName - The package name of the application for which this subscription was purchased (for example, 'com.some.thing').

subscriptionId - The purchased subscription ID (for example, 'monthly001').

token - The token provided to the user's device when the subscription was purchased.

Returns:

the request

Throws:

IOException

refund

public AndroidPublisher.Purchases.Subscriptions.Refund refund(String packageName,
                                                              String subscriptionId,
                                                              String token)
                                                       throws IOException

Deprecated: Use orders.refund instead. Refunds a user's subscription purchase, but the subscription remains valid until its expiration time and it will continue to recur. Create a request for the method "subscriptions.refund". This request holds the parameters needed by the androidpublisher server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

packageName - The package name of the application for which this subscription was purchased (for example, 'com.some.thing').

subscriptionId - "The purchased subscription ID (for example, 'monthly001').

token - The token provided to the user's device when the subscription was purchased.

Returns:

the request

Throws:

IOException

revoke

public AndroidPublisher.Purchases.Subscriptions.Revoke revoke(String packageName,
                                                              String subscriptionId,
                                                              String token)
                                                       throws IOException

Deprecated: Use purchases.subscriptionsv2.revoke instead. Refunds and immediately revokes a user's subscription purchase. Access to the subscription will be terminated immediately and it will stop recurring. Create a request for the method "subscriptions.revoke". This request holds the parameters needed by the androidpublisher server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

packageName - The package name of the application for which this subscription was purchased (for example, 'com.some.thing').

subscriptionId - The purchased subscription ID (for example, 'monthly001').

token - The token provided to the user's device when the subscription was purchased.

Returns:

the request

Throws:

IOException